Skip to main content
GET
/
api
/
v1
/
organizations
/
{orgId}
/
members
List Members
curl --request GET \
  --url https://api.bunship.com/api/v1/organizations/{orgId}/members \
  --header 'Authorization: Bearer <token>'
{
  "members": [
    {
      "id": "mbr_abc123",
      "userId": "usr_cld2abc123def456",
      "organizationId": "org_cld2abc123def456",
      "role": "owner",
      "user": {
        "id": "usr_cld2abc123def456",
        "email": "owner@example.com",
        "fullName": "John Doe",
        "avatarUrl": "https://cdn.bunship.com/avatars/john.jpg"
      },
      "joinedAt": "2024-01-15T10:00:00Z"
    },
    {
      "id": "mbr_def456",
      "userId": "usr_xyz789ghi012345",
      "organizationId": "org_cld2abc123def456",
      "role": "member",
      "user": {
        "id": "usr_xyz789ghi012345",
        "email": "jane@example.com",
        "fullName": "Jane Smith",
        "avatarUrl": null
      },
      "joinedAt": "2024-02-01T14:30:00Z"
    }
  ],
  "total": 2
}
Returns all members of the organization, including their user profile and role. Requires the members:read permission.

​
Auth

Requires a valid Bearer token with members:read permission.

​
Path Parameters

​
orgId
string
required
Organization identifier.

​
Response

​
members
array
Array of member objects.
​
total
number
Total number of members.
{
  "members": [
    {
      "id": "mbr_abc123",
      "userId": "usr_cld2abc123def456",
      "organizationId": "org_cld2abc123def456",
      "role": "owner",
      "user": {
        "id": "usr_cld2abc123def456",
        "email": "owner@example.com",
        "fullName": "John Doe",
        "avatarUrl": "https://cdn.bunship.com/avatars/john.jpg"
      },
      "joinedAt": "2024-01-15T10:00:00Z"
    },
    {
      "id": "mbr_def456",
      "userId": "usr_xyz789ghi012345",
      "organizationId": "org_cld2abc123def456",
      "role": "member",
      "user": {
        "id": "usr_xyz789ghi012345",
        "email": "jane@example.com",
        "fullName": "Jane Smith",
        "avatarUrl": null
      },
      "joinedAt": "2024-02-01T14:30:00Z"
    }
  ],
  "total": 2
}

​
Errors

StatusCodeDescription
401AUTHENTICATION_ERRORMissing or invalid Bearer token
403AUTHORIZATION_ERRORInsufficient permissions (members:read required)
404NOT_FOUNDOrganization not found

​
Example

curl https://api.bunship.com/api/v1/organizations/org_cld2abc123def456/members \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."