Matchai Docs

Get a teamComing soon

Returns one team.

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

Coming soon. Returns one team.

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

Response Body

The team.

application/json
  1. response
id*string

Team id.

Length1 <= length <= 64
name*string

Name.

description?|

Description.

picture_url?|

Picture.

Formaturi
your_role*Role

owner: full control. admin: edit and manage. member: view.

Value in"owner""admin""member"
member_count*integer

Members.

Range1 <= value
conversation_id?|

The team’s conversation.

Length1 <= length <= 64
archived_at?|

Archived.

Formatdate-time
created_at*string

Created.

Formatdate-time
updated_at*string

Last changed.

Formatdate-time
Example Request
curl -X GET 'https://api.matchai.co/v1/teams/string'
Example Response
{  "id": "string",  "name": "string",  "description": "string",  "picture_url": "http://example.com",  "your_role": "owner",  "member_count": 1,  "conversation_id": "string",  "archived_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}