Skip to content

All resources

project-members

6 endpoints

get /projects/{projectId}/members

List a project's members

Requires authentication

Returns the project member roster with each member's role and trimmed user.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

post /projects/{projectId}/members

Add a member to a project

Requires authentication

Adds an org member to the project (defaults to the member role) and returns the created membership.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: handler.AddMemberRequest

NameTypeRequiredDescription
roledomain.ProjectRoleno
userIdintegerno

Responses

  • 201 Created · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

patch /projects/{projectId}/members/{userId}

Update a project member's role

Requires authentication

Updates a member's project role and returns the updated membership.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id
userIdpathintegeryesTarget user id

Request body: handler.UpdateRoleRequest

NameTypeRequiredDescription
roledomain.ProjectRoleno

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

delete /projects/{projectId}/members/{userId}

Remove a member from a project

Requires authentication

Removes a member from the project and returns a confirmation message.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id
userIdpathintegeryesTarget user id

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

get /projects/{projectId}/members/assignable

List users assignable to project tasks

Requires authentication

Returns all users who can be assigned to tasks in the project.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

get /projects/{projectId}/members/available

List org members not yet on the project

Requires authentication

Returns org members eligible to be added to the project.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope