API by router
Team
GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?curl -X GET 'https://example.com/v1/team/invitations'Example Response
[ { "created_at": "2019-08-24T14:15:22Z", "email": "string", "expires_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777", "invited_by_email": "string", "role": "string", "status": "string", "token": "string" }]POST
HTTPBearerheader
AuthorizationBearer <token>application/json- body
token*TokenLength
1 <= length <= 64Successful Response
application/json- response
created_at*Created AtFormat
date-timedisplay_name?string|nullemail*Emailis_active*Is Activeis_admin*Is Adminlast_login?|nullteam_role*Team Roleuser_id*User IdFormat
uuidcurl -X POST 'https://example.com/v1/team/invitations/accept' \ -H 'Content-Type: application/json' \ -d '{ "token": "string"}'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "display_name": "string", "email": "string", "is_active": true, "is_admin": true, "last_login": "2019-08-24T14:15:22Z", "team_role": "string", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"}DELETE
HTTPBearerheader
AuthorizationBearer <token>invitation_id*Invitation IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/team/invitations/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty
POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
email*EmailFormat
emailrole?RoleTeam role for the invitee
Default
"member"Successful Response
application/json- response
created_at*Created AtFormat
date-timeemail*Emailexpires_at*Expires AtFormat
date-timeid*IdFormat
uuidinvited_by?|nullinvited_by_email?string|nullrole*Rolestatus*Statustoken?string|nullcurl -X POST 'https://example.com/v1/team/invite' \ -H 'Content-Type: application/json' \ -d '{ "email": "user@example.com"}'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "email": "string", "expires_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777", "invited_by_email": "string", "role": "string", "status": "string", "token": "string"}GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?curl -X GET 'https://example.com/v1/team/members'Example Response
[ { "created_at": "2019-08-24T14:15:22Z", "display_name": "string", "email": "string", "is_active": true, "is_admin": true, "last_login": "2019-08-24T14:15:22Z", "team_role": "string", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5" }]DELETE
HTTPBearerheader
AuthorizationBearer <token>member_id*Member IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/team/members/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty
PATCH
HTTPBearerheader
AuthorizationBearer <token>member_id*Member IdFormat
uuidX-Api-Key?string|nullapplication/json- body
team_role*Team RoleNew team role
Successful Response
application/json- response
created_at*Created AtFormat
date-timedisplay_name?string|nullemail*Emailis_active*Is Activeis_admin*Is Adminlast_login?|nullteam_role*Team Roleuser_id*User IdFormat
uuidcurl -X PATCH 'https://example.com/v1/team/members/497f6eca-6276-4993-bfeb-53cbbbba6f08/role' \ -H 'Content-Type: application/json' \ -d '{ "team_role": "string"}'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "display_name": "string", "email": "string", "is_active": true, "is_admin": true, "last_login": "2019-08-24T14:15:22Z", "team_role": "string", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"}