Use this API to manage invitations and add users to a group or project.

List all pending invitations for a group

GET /api/v4/groups/{id}/invitations

Lists all pending invitations for a specified group viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters page and per_page to restrict the list of members.

Parameters

NameTypeDescription
id
Path, required		StringThe group ID
page
Query		IntegerCurrent page number
Default: 1
Example: 1
per_page
Query		IntegerNumber of items per page
Default: 20
Example: 20
query
Query		StringA query string to search for members

Responses

CodeDescriptionSchema
200OKAPIEntitiesInvitation
400Bad Request—
404Not Found—

Add a member to a group

POST /api/v4/groups/{id}/invitations

Adds a member to a group. You can specify a user ID or invite a user by email.

Parameters

NameTypeDescription
id
Path, required		StringThe group ID

Request body (application/json)

PropertyTypeDescription
access_level
Required		IntegerA valid access level (defaults: 30, developer access level)
Allowed values: 10, 15, 20, 25, 30, 40, 50
emailArray of stringsThe email address to invite, or multiple emails separated by comma
expires_atString (date-time)Date string in the format YEAR-MONTH-DAY
invite_sourceStringSource that triggered the member creation process
Default: invitations-api
user_idArray of stringsThe user ID of the new member or multiple IDs separated by commas

Responses

CodeDescriptionSchema
201CreatedAPIEntitiesInvitation
400Bad Request—
404Not Found—

Update an invitation to a group

PUT /api/v4/groups/{id}/invitations/{email}

Updates a pending invitation to a group.

Parameters

NameTypeDescription
id
Path, required		StringThe group ID
email
Path, required		StringThe email address of the invitation

Request body (application/json)

PropertyTypeDescription
access_levelIntegerA valid access level (defaults: 30, developer access level)
Allowed values: 10, 15, 20, 25, 30, 40, 50
expires_atString (date-time)Date string in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

Responses

CodeDescriptionSchema
200OKAPIEntitiesInvitation
400Bad Request—
404Not Found—

Delete an invitation to a group

DELETE /api/v4/groups/{id}/invitations/{email}

Deletes a pending invitation to a specified email address for a group.

Parameters

NameTypeDescription
id
Path, required		StringThe group ID
email
Path, required		StringThe email address of the invitation

Responses

CodeDescriptionSchema
204No Content—
400Bad Request—
403Forbidden—
404Not found—
409Could not delete invitation—

List all pending invitations for a project

GET /api/v4/projects/{id}/invitations

Lists all pending invitations for a specified project viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters page and per_page to restrict the list of members.

Parameters

NameTypeDescription
id
Path, required		StringThe project ID
page
Query		IntegerCurrent page number
Default: 1
Example: 1
per_page
Query		IntegerNumber of items per page
Default: 20
Example: 20
query
Query		StringA query string to search for members

Responses

CodeDescriptionSchema
200OKAPIEntitiesInvitation
400Bad Request—
404Not Found—

Add a member to a project

POST /api/v4/projects/{id}/invitations

Adds a member to a project. You can specify a user ID or invite a user by email.

Parameters

NameTypeDescription
id
Path, required		StringThe project ID

Request body (application/json)

PropertyTypeDescription
access_level
Required		IntegerA valid access level (defaults: 30, developer access level)
Allowed values: 10, 15, 20, 25, 30, 40, 50
emailArray of stringsThe email address to invite, or multiple emails separated by comma
expires_atString (date-time)Date string in the format YEAR-MONTH-DAY
invite_sourceStringSource that triggered the member creation process
Default: invitations-api
user_idArray of stringsThe user ID of the new member or multiple IDs separated by commas

Responses

CodeDescriptionSchema
201CreatedAPIEntitiesInvitation
400Bad Request—
404Not Found—

Update an invitation to a project

PUT /api/v4/projects/{id}/invitations/{email}

Updates a pending invitation to a project.

Parameters

NameTypeDescription
id
Path, required		StringThe project ID
email
Path, required		StringThe email address of the invitation

Request body (application/json)

PropertyTypeDescription
access_levelIntegerA valid access level (defaults: 30, developer access level)
Allowed values: 10, 15, 20, 25, 30, 40, 50
expires_atString (date-time)Date string in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

Responses

CodeDescriptionSchema
200OKAPIEntitiesInvitation
400Bad Request—
404Not Found—

Delete an invitation to a project

DELETE /api/v4/projects/{id}/invitations/{email}

Deletes a pending invitation to a specified email address for a project.

Parameters

NameTypeDescription
id
Path, required		StringThe project ID
email
Path, required		StringThe email address of the invitation

Responses

CodeDescriptionSchema
204No Content—
400Bad Request—
403Forbidden—
404Not found—
409Could not delete invitation—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesInvitation

PropertyTypeDescription
access_levelString—
created_atString—
created_by_nameString—
expires_atString—
invite_emailString—
invite_tokenString—
user_nameString—
←
REST API / Internal operations
REST API / Issues
→