Docs
Search…
Team

DELETE /v1/team/member/{id}

Description

200 OK indicates that the member was removed from the team.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

POST /v1/team/invite

Description

Create a new team invite.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
inviter_id
uuid
yes
Account ID of the account creating the invite
email
string
yes
Invitee email address
team_id
string
yes
Team ID that the invitee is being invited to

Example Response

{
"id":"88f5b8b9-d077-4d10-b7db-fba4bd4eb937",
"email":"[email protected]",
"inviter_id":"d59d88ee-6a78-495d-872b-96d2799fd2f1",
"team":{
"id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
"name":"Batch"
}
}

GET /v1/team/member

Description

Get members of a team.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

GET /v1/account/team

Description

Get the teams that an account is part of.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

PUT /v1/account/team

Description

{"team_id:"...."}
A new JWT will be returned with the new team associated with it, and the user's old JWT will be blacklisted

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

GET /v1/team/invite

Description

No body needed. A simple GET request will return all invites for the teamID present in the user's JWT.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Example Response

[
{
"id":"88f5b8b9-d077-4d10-b7db-fba4bd4eb937",
"email":"[email protected]",
"inviter_id":"d59d88ee-6a78-495d-872b-96d2799fd2f1",
"team":{
"id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
"name":"Batch"
}
}
]

POST /v1/sign-up/invitee/{id}

Description

Accept an invite.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

DELETE /v1/team/invite/{id}

Description

Cancel an active invite.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

GET /v1/team/invite/{id}

Description

Fetch a team invite.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

GET /v1/team/invite/{id}

Description

Get info about a specific invite.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Last modified 1yr ago
Copy link
On this page
DELETE /v1/team/member/{id}
POST /v1/team/invite
GET /v1/team/member
GET /v1/account/team
PUT /v1/account/team
GET /v1/team/invite
POST /v1/sign-up/invitee/{id}
DELETE /v1/team/invite/{id}
GET /v1/team/invite/{id}
GET /v1/team/invite/{id}