Skip to main content
All CollectionsAPI Documentation
Projects, Workspaces, Tenant Teams API
Projects, Workspaces, Tenant Teams API
Updated over a year ago

Teams - Tenant - Get Members

Retrieve the team members of a specific tenant.

GET /teams/tenants/:tenantId

Request Headers

Authorization: Bearer <token>

Path Parameters

tenantId: string (required)

Query Parameters

page: number (optional, default: 1)
pageSize: number (optional, default: 10)
sortAttribute: string (optional, default: 'name')
sortDirection: string (optional, default: 'asc')
filter: string (optional)

Success Response

HTTP/1.1 200 OK { "members": [...], "total": ... }

Teams - Tenant - Get Member by ID

Retrieve a specific team member of a tenant.

GET /teams/tenants/:tenantId/members/:memberId

Request Headers

Authorization: Bearer <token>

Path Parameters

tenantId: string (required)
memberId: string (required)

Success Response

HTTP/1.1 200 OK { "member": ... }

Error Response

HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } }

Teams - Project - Get Members

Retrieve the team members of a specific project within a tenant.

GET /teams/tenants/:tenantId/projects/:projectId

Request Headers

Authorization: Bearer <token>

Path Parameters

tenantId: string (required)
projectId: string (required)

Query Parameters

page: number (optional, default: 1)
pageSize: number (optional, default: 10)
sortAttribute: string (optional, default: 'name')
sortDirection: string (optional, default: 'asc')
filter: string (optional)

Success Response

HTTP/1.1 200 OK { "members": [...] }

Teams - Project - Get Member by ID

Retrieve a specific team member of a project within a tenant.

GET /teams/tenants/:tenantId/projects/:projectId/members/:memberId

Request Headers

Authorization: Bearer <token>

Path Parameters

tenantId: string (required)
projectId: string (required)
memberId: string (required)

Success Response

HTTP/1.1 200 OK { "member": ... }

Error Response

HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } }

Teams - Project - Get Available Members for RAID

Retrieve the available team members that can be assigned to a RAID item in a specific project within a tenant.

GET /teams/tenants/:tenantId/projects/:projectId/available

Request Headers

Authorization: Bearer <token>

Path Parameters

tenantId: string (required)
projectId: string (required)

Success Response

HTTP/1.1 200 OK { "members": [...] }

Teams - Project - Get Available Members to Invite

Retrieve the available team members that can be invited to a specific project within a tenant.

GET /teams/tenants/:tenantId/projects/:projectId/toinvite

Request Headers

Authorization: Bearer <token>

Path Parameters

tenantId: string (required)
projectId: string (required)

Success Response

HTTP/1.1 200 OK { "members": [...] }

Teams - Tenant - Invite

Invite or add members to the tenant team.

POST /teams/tenants/:tenantId/members

Request Headers

Authorization: Bearer <token>

Request Body

{ "members": [ { "email": "string", "name": "string" }, ... ] }

The members array should contain objects with either the email or name property. The email property represents the email address of the member to be invited, while the name property represents the name of the member to be added without an email address.

Example:

{ "members": [ { "email": "[email protected]" }, { "name": "John Doe" } ] }

Success Response

HTTP/1.1 201 Created { "members": [...] }

Error Response

HTTP/1.1 400 Bad Request { "errors": [...] }
HTTP/1.1 404 Not Found { "error": { "status": 404, "message": "No members added to tenant" } }

Teams - Project - Invite

Invite or add members to a project team.

POST /teams/tenants/:tenantId/projects/:projectId/members

Request Headers

Authorization: Bearer <token>

Request Body

{ "members": [ { "uuid": "" }, { "email": "" }, { "name": "" } ] }

Success Response

HTTP/1.1 201 Created { "members": [ // List of created team members ] }

Error Response

HTTP/1.1 404 Not Found { "error": { "status": 404, "message": "No members added to project" } }

Teams - Tenant - Update Member Status

Update the role status of a tenant member.

PUT /teams/tenants/:tenantId/members/:memberId/status

Request Headers

Authorization: Bearer <token>

Request Body

{ "status": "Revoked" or null }

Success Response

HTTP/1.1 204 No Content OK

Error Response

HTTP/1.1 400 Bad Request { "error": { "status": 400, "message": "Invalid status" } }
HTTP/1.1 404 Not Found { "error": { "status": 404, "message": "Not Found" } }

Teams - Tenant - Update Member Role

Update the role of a tenant member.

PUT /teams/tenants/:tenantId/members/:memberId/role

Request Headers

Authorization: Bearer <token>

Request Body

{ "role": "Owner,Member,Collaborator,None" }

Success Response

HTTP/1.1 200 OK Content-Type: application/json { "member": { "id": "1234567890qwertyuiopasdf", "role": "Role", "name": "John Doe", "email": "[email protected]" } }

Error Response

HTTP/1.1 400 Bad Request { "error": { "status": 400, "message": "Invalid role" } }
HTTP/1.1 404 Not Found { "error": { "status": 404, "message": "Not Found" } }

Teams - Project - Update Member Status

Update the role status of a project member.

PUT /teams/tenants/:tenantId/projects/:projectId/members/:memberId/status

Request Headers

Authorization: Bearer <token>

Request Body

{ "status": "Revoked" or null }

Success Response

HTTP/1.1 204 No Content OK

Error Response

HTTP/1.1 400 Bad Request { "error": { "status": 400, "message": "Invalid status" } }
HTTP/1.1 404 Not Found { "error": { "status": 404, "message": "Not Found" } }

Teams - Project - Update Member Role

Update the role of a project member.

PUT /teams/tenants/:tenantId/projects/:projectId/members/:memberId/role

Request Headers

Authorization: Bearer <token>

Request Body

{ "role": "Owner,Member,Contributor,Viewer,None" }

Success Response

HTTP/1.1 200 OK Content-Type: application/json { "member": { "id": "1234567890qwertyuiopasdf", "role": "Role", "name": "John Doe", "email": "[email protected]" } }

Error Response

HTTP/1.1 400 Bad Request { "error": { "status": 400, "message": "Invalid role" } }
HTTP/1.1 404 Not Found { "error": { "status": 404, "message": "Not Found" } }
Did this answer your question?