Back to top

Invitations

Invitation Management (Project)

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"
    	},
    	"project": {
    		"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"
    	],
    	"owner": "boolean",
    	"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
Create an invitation
/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  201   created
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"invitee": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"invited_by": {
    		"href": "string"
    	},
    	"project": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity