Teams API

Codemagic REST API Teams API

API for managing team members

This document describes the API endpoints for managing teams. To use this API, you must be a team admin.

Read more about the Teams feature, the available user roles and permissions.

Invite a new team member

Invite a new team member to your team.

POST /team/:team_id/invitation

Parameters

NameTypeDescription
emailstringRequired. User email
rolestringRequired. Could be owner or developer

developer role corresponds to the Member role and owner role corresponds to the Admin role in Codemagic UI.

Example

curl -H "Content-Type: application/json" \
     -H "x-auth-token: <API Token>" \
     -d '{
        "email": "your_user@domain.com",
        "role": "developer"
     }' \
     -X POST https://api.codemagic.io/team/<team_id>/invitation

Response

A full team object is returned.

Delete a team member

Remove a team member from the team.

DELETE /team/:team_id/collaborator/:user_id

Example

curl -H "Content-Type: application/json" \
     -H "x-auth-token: <API Token>" \
     -X DELETE https://api.codemagic.io/team/<team_id>/collaborator/<user_id>