Back to top

Invitations

Manage invitations. See project endpoints to create a new invitation.

View an invitation
GET
/invitations/{id}

Returns a single invitation.

  • 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
  • Response  200   ok
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"invitee": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"invited_by": {
    		"href": "string"
    	},
    	"invitable": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Accept an invitation
PUT
/invitations/{id}

Accept an invitation.

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

  • Response  200   ok
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"created_at": "string",
    	"updated_at": "string",
    	"project": {
    		"href": "string"
    	},
    	"user": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Decline an invitation
/invitations/{id}

Decline an invitation.

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve project invitations
/projects/{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  200   ok
  • {
    	"invitations": [
    		{
    			"id": "string",
    			"roles": [
    				"string"
    			],
    			"created_at": "string",
    			"updated_at": "string",
    			"project": {
    				"href": "string"
    			},
    			"user": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create an invitation for a project
GET
/projects/{id}/invitations

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

  • Parameters
  • id
    string  (required) in path

    Project UUID

    invitation
     (required) in body

    Invitation to create

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	]
    } 
  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  201   created
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"invitee": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"invited_by": {
    		"href": "string"
    	},
    	"invitable": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve organization invitations
/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  200   ok
  • {
    	"invitations": [
    		{
    			"id": "string",
    			"roles": [
    				"string"
    			],
    			"created_at": "string",
    			"updated_at": "string",
    			"project": {
    				"href": "string"
    			},
    			"user": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create an invitation for an organization
GET
/organizations/{id}/invitations

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

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    invitation
     (required) in body

    Invitation to create

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	]
    } 
  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  201   created
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"invitee": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"invited_by": {
    		"href": "string"
    	},
    	"invitable": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity