Skip to main content
Retrieve a paginated list of members in the workspace.

​
Query Parameters

​
limit
number
default:"20"
Number of members to return (1-100)
​
offset
number
default:"0"
Pagination offset
​
search
string
Search by name or email

​
Response

​
items
array
List of members
​
pagination
object
Pagination metadata

​
Example Request

curl -X GET 'https://api.caret.so/v1/workspace/members?limit=10&offset=0&search=john' \
  -H 'Authorization: Bearer {api_key}'

​
Example Response

{
  "items": [
    {
      "id": "01887270-45ab-7da0-c95d-9a9e9ebc5e89",
      "userId": "01887270-45ab-7da0-c95d-9a9e9ebc5e89",
      "name": "John Doe",
      "email": "[email protected]",
      "profileUrl": "https://example.com/profiles/john.jpg",
      "role": "admin",
      "createdAt": "2023-01-15T08:30:00Z",
      "groups": [
        {
          "id": "01887270-56cd-7da0-c95d-9a9e9ebc6f90",
          "name": "Engineering"
        },
        {
          "id": "01887270-67ef-7da0-c95d-9a9e9ebc7g01",
          "name": "Leadership"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 10,
    "nextOffset": 10,
    "isLast": true
  }
}