Matchai Docs

List team membersComing soon

Returns the team’s members and their roles.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/teams/{team_id}/members

Coming soon. Returns the team’s members and their roles.

Scopes: teams:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: teams:read

Path Parameters

team_id*string

Team id.

Length1 <= length <= 64

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512

Response Body

One page of members.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/teams/string/members'
Example Response
{  "data": [    {      "professional_id": "string",      "contact_id": "string",      "user_id": "string",      "display_name": "string",      "username": "string",      "avatar_url": "http://example.com",      "role": "owner",      "joined_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}