Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Project Invitations

List invitations to a project

Returns a list of invitations to a project.

get/projects/{project_id}/invitations

Query parameters

eqstring

Equal

nestring

Not equal

instring

In (comma-separated list)

ninstring

Not in (comma-separated list)

betweenstring

Between (comma-separated list)

containsstring

Contains

startsstring

Starts with

endsstring

Ends with

Allows filtering by state of the invtations: "pending" (default), "error".

page[size]integer

Determines the number of items to show.

page[before]string

Pagination cursor. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.

page[after]string

Pagination cursor. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.

sort'updated_at' | '-updated_at'

Allows sorting by a single field.<br> Use a dash ("-") to sort descending.

Response

OK

idstring uuid

The ID of the invitation.

state'pending' | 'processing' | 'accepted' | 'cancelled' | 'error'

The invitation state.

project_idstring

The ID of the project.

role'admin' | 'viewer'

The project role.

emailstring email

The email address of the invitee.

created_atstring date-time

The date and time when the invitation was created.

updated_atstring date-time

The date and time when the invitation was last updated.

finished_atstring date-time nullable

The date and time when the invitation was finished.