show

Invitations

Manage invitations. See project endpoints to create a new invitation. Check out the product docs to learn more about Invitations.

View an invitation

GET
/invitations/{id}

Returns a single invitation. (It include the invitable to maintain backward compatibility but will be removed soon)

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Accept an invitation

PUT
/invitations/{id}

Accept an invitation.

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

Decline an invitation

DELETE
/invitations/{id}

Decline an invitation.

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

Retrieve project invitations

GET
/projects/{project_id}/invitations

Returns all invitations in a project.

  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

    project_id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for a project

POST
/projects/{project_id}/invitations

In order to add a user to a project, they must first be invited.

  • Parameters
  • project_id
    string  (required) in path

    Project UUID

    invitation
     (required) in body

    Invitation to create

    invitee

    {
    "invitee": "string",
    "message": "string",
    "roles": [
        "string"
    ],
    "projects_ids": [
        "string"
    ]
}

Retrieve organization invitations

GET
/organizations/{id}/invitations

Returns all invitations in an organization.

  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

    id
    string  (required) in path

    Organization UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for an organization

POST
/organizations/{id}/invitations

In order to add a user to an organization, they must first be invited. To invite to several projects the parameter projects_ids:[a,b,c] can be used

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    invitation
     (required) in body

    Invitation to create

    invitee

    {
    "invitee": "string",
    "message": "string",
    "roles": [
        "string"
    ],
    "projects_ids": [
        "string"
    ]
}

Retrieve current user invitations

GET
/invitations

Returns all invitations in current user.

  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide