Organization Members

Organization member management endpoints

Get organization members

get

Retrieve all members of an organization

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

Responses

200

Organization members retrieved successfully

application/json

400

Invalid organization ID format.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to list organization members.

application/json

404

Organization not found with the provided ID.

application/json

500

Internal server error occurred while retrieving organization members.

application/json

get

/api/v1/orgs/{org_id}/members

HTTPcURLJavaScriptPython

GET /api/v1/orgs/{org_id}/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "member_id": "123e4567-e89b-12d3-a456-426614174000",
      "member_email": "[email protected]",
      "member_role": "member"
    }
  ]
}

Add organization member

post

Add a new member to an organization by sending an invitation or update the role of an existing member to an organization.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

Body

application/json

Request payload adding a user to an organization

member_emailstring · emailRequired

Email address of the user to invite

Example: [email protected]

member_rolestring · enumRequired

Role to be assigned to the member in the organization

Example: memberPossible values:

messagestring · max: 500Optional

Optional personal message to include in the invitation email

Example: Welcome to our team! We're excited to have you join us.

Responses

201

Invitation sent to the member or member added to the organization successfully

application/json

400

Invalid data format or missing required fields.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to add organization member.

application/json

404

Organization not found.

application/json

409

User is already a member of the organization with the same role.

application/json

500

Internal server error occurred while adding organization member.

application/json

post

/api/v1/orgs/{org_id}/members

HTTPcURLJavaScriptPython

POST /api/v1/orgs/{org_id}/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "member_email": "[email protected]",
  "member_role": "member",
  "message": "Welcome to our team! We're excited to have you join us."
}

{
  "member_id": "123e4567-e89b-12d3-a456-426614174000",
  "member_email": "[email protected]",
  "member_role": "member",
  "message": "Invitation sent successfully",
  "expires_at": "2025-08-21T12:34:56Z"
}

Remove organization member

delete

Remove a member from an organization

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

member_idstringRequired

Member User ID

Responses

200

Member removed successfully

application/json

400

Invalid organization ID or member user ID format.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to remove organization member.

application/json

404

Organization or member user not found.

application/json

500

Internal server error occurred while removing organization member.

application/json

delete

/api/v1/orgs/{org_id}/members/{member_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/orgs/{org_id}/members/{member_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Operation completed successfully"
}