members.list
Current members of a shop with role and start date.
When to use it
Answer who is on the team, their role and start date.
What to tell the owner
Here's your team and each person's role.
| Field | Type | Required |
|---|
shop_id | string | yes |
include_ended | string | no |
Example
GET https://doingwork.work/v1/members?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
members | array | yes |
members[].membership_id | string (uuid) | yes |
members[].person_id | string (uuid) | yes |
members[].display_name | ['string', 'null'] | yes |
members[].role | string | yes |
members[].started_at | string (date-time) | yes |
members[].ended_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
members[].ended_reason | ['string', 'null'] | yes |
{
"members": [
{
"membership_id": "00000000-0000-4000-8000-000000000000",
"person_id": "00000000-0000-4000-8000-000000000000",
"display_name": "...",
"role": "...",
"started_at": "...",
"ended_at": "...",
"ended_reason": "..."
}
]
}
Errors
| Code | Status | What to do |
|---|
forbidden | 403 | This worker's role can't do this, or it needs a person's own sign-in rather than an agent token. Tell the person who can. |
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |