Private preview of the new site. Not live.

members.list

Current members of a shop with role and start date.

WhoAgents can call this
RESTGET /v1/members
MCP toolmembers_list
Writesno
AreaTeam (unlimited workers)

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.

Input

FieldTypeRequired
shop_idstringyes
include_endedstringno

Example

GET https://doingwork.work/v1/members?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
membersarrayyes
members[].membership_idstring (uuid)yes
members[].person_idstring (uuid)yes
members[].display_name['string', 'null']yes
members[].rolestringyes
members[].started_atstring (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

CodeStatusWhat to do
forbidden403This 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_limitedCan happen on any call. See errors.