List Members

Get a paginated list of members in the workspace

GET /v1/workspace/members

curl

curl -X GET "https://api.caret.so/v1/workspace/members?limit=20&offset=0" \
     -H "Authorization: Bearer your_api_key_here"

200 OK

{
  "items": [
    {
      "id": "user_123456789",
      "name": "John Doe",
      "email": "[e-mail]",
      "profileUrl": "https://example.com/profile.jpg",
      "role": "admin",
      "createdAt": "2023-01-01T00:00:00Z",
      "folders": [
        {
          "id": "folder_123",
          "name": "Product"
        }
      ],
      "groups": [
        {
          "id": "folder_123",
          "name": "Product"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "nextOffset": null,
    "isLast": true
  }
}

Overview

This endpoint returns a paginated list of members in the workspace. You can filter the results by name or email using the search parameter.

Authentication

All API requests must use Authorization: Bearer <API_KEY>. This endpoint requires the users scope.

Authorization · string · required

Bearer token. Format: Bearer <API_KEY>.

Query Parameters

limit · number · default: "20"

Number of items per page (1-100).

offset · number · default: "0"

Starting position.

search · string

Search by name or email.

Response

items · object[]

List of workspace members.

Show properties

id · string

Unique identifier for the user in the workspace (user ID).

name · string

User name.

email · string

User email.

profileUrl · string | null

Profile image URL.

role · string

User role in the workspace.

createdAt · string

ISO8601 timestamp of when the user joined.

folders · object[]

User folders.

Show properties

id · string

Folder ID.

name · string

Folder name.

groups · object[]

User groups (v1 alias for folders, same data as folders).

pagination · object

Pagination metadata.

Show properties

limit · number

Number of items per page.

nextOffset · number | null

Offset for the next page, null if last page.

isLast · boolean

Whether this is the last page.

curl

curl -X GET "https://api.caret.so/v1/workspace/members?limit=20&offset=0" \
     -H "Authorization: Bearer your_api_key_here"

200 OK

{
  "items": [
    {
      "id": "user_123456789",
      "name": "John Doe",
      "email": "[e-mail]",
      "profileUrl": "https://example.com/profile.jpg",
      "role": "admin",
      "createdAt": "2023-01-01T00:00:00Z",
      "folders": [
        {
          "id": "folder_123",
          "name": "Product"
        }
      ],
      "groups": [
        {
          "id": "folder_123",
          "name": "Product"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "nextOffset": null,
    "isLast": true
  }
}