curl 'https://api.mails.ai/v1/members' \
  -H "Authorization: Bearer $MAILS_API_KEY"

mails members list
mails members list --json | jq -r '.data[].email'

{ "name": "mails_list_members", "arguments": {} }

{
  "data": [
    {
      "id": "usr_01JZX8K3M9Q4P7VN2YB6RTDC0E",
      "email": "jordan@example.com",
      "name": "<name>",
      "role": "owner"
    }
  ]
}

200  The workspace's members.
401  Missing or invalid API key.
403  The API key lacks the required scope
     (insufficient_scope), or the token belongs to an
     app connected by sign-in and this operation is
     closed to connected apps
     (connected_app_not_allowed).
500  Internal server error.

List members

Everyone in the workspace, oldest member first, all at once: the people a thread can be assigned to (PATCH /v1/threads/{id} with assignee).

GET/v1/membersscope · read

curl 'https://api.mails.ai/v1/members' \
  -H "Authorization: Bearer $MAILS_API_KEY"

mails members list
mails members list --json | jq -r '.data[].email'

{ "name": "mails_list_members", "arguments": {} }

{
  "data": [
    {
      "id": "usr_01JZX8K3M9Q4P7VN2YB6RTDC0E",
      "email": "jordan@example.com",
      "name": "<name>",
      "role": "owner"
    }
  ]
}

200  The workspace's members.
401  Missing or invalid API key.
403  The API key lacks the required scope
     (insufficient_scope), or the token belongs to an
     app connected by sign-in and this operation is
     closed to connected apps
     (connected_app_not_allowed).
500  Internal server error.

Response

dataobject[]

Every member of the workspace, oldest first.

Show propertiesHide properties

idstring

The member's user id (usr_…). PATCH /v1/threads/{id} takes it, or the email, as assignee.

emailstring

The member's email address.

namestring | null

The member's name, or null when they have not given one.

rolestring

The member's role in the workspace (Settings → Team). Any member can be assigned a thread, whatever the role.

One of: owner, admin, member, billing

Was this page helpful?