Skip to main content
POST
/
api
/
projects
/
{projectId}
/
members
/
join
Join project
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/members/join \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "owner": true,
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "firstName": "<string>",
    "lastName": "<string>",
    "type": "<string>",
    "status": "<string>",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "isService": true
  },
  "groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "permissions": [
        "<string>"
      ],
      "description": "<string>",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
projectId
string<uuid>
required

Unique identifier of the project to join

Response

200 - application/json

The newly created membership record

The newly created membership record

​
id
string<uuid>
required

Unique identifier of the member

​
createdAt
string
required

Timestamp when the member was created

​
updatedAt
string
required

Timestamp when the member was last updated

​
owner
boolean

Whether the member is an owner of the project

​
userId
string<uuid>

User ID of the member

​
projectId
string<uuid>

Project ID the member belongs to

​
user
object

User details of the member

​
groups
object[]

Groups the member belongs to