Skip to main content
Version: 5.3.7

Collaborator API

Get collaborator​

Retrieve the details of an app's collaborator.

GET /api/apps/:app_id/collaborators/:user_id

Paramters​

info

Authentication required and the user must have global developer or app developer permissions.

AttributeTypeRequiredDescription
app_idIntegertrueApp ID
user_idIntegertrueUser ID

Return body​

{
"id": 6,
"username": "foo",
"email": "foo@zealot.com",
"role": "user"
}

Add collaborator​

Add an existing user to the app's collaborators list.

Paramters​

info

Authentication required and the user must have global developer or app developer permissions.

AttributeTypeRequiredDescription
app_idIntegertrueApp ID
user_idIntegertrueUser ID

Return body​

  • Return 404 if channel not existed.
  • Return 201 and response body if successful
{
"id": 6,
"username": "foo",
"email": "foo@zealot.com",
"role": "user"
}

Edit collaborator's role​

Edit collaborator's role.

PUT /api/apps/:app_id/collaborators/:user_id

Paramters​

info

Authentication required and the user must have global developer or app developer permissions.

AttributeTypeRequiredDescription
app_idIntegertrueApp ID
user_idIntegertrueUser ID
roleStringtrueUser role, defaults to "user", options are user/developer/admin

Return body​

{
"id": 6,
"username": "foo",
"email": "foo@zealot.com",
"role": "developer"
}

Remove collaborator​

Remove a collaborator from app.

DELETE /api/apps/:app_id/collaborators/:user_id

Paramters​

info

Authentication required and the user must have global developer or app developer permissions.

AttributeTypeRequiredDescription
app_idIntegertrueApp ID
user_idIntegertrueUser ID

Return body​

  • Return 404 if app not existed.
  • Return 200 if success.