v1

latestOpenAPI 3.0.02026-07-17121287546.7 KB
Deprecated: Platform / Managed Users

Get all managed users

<Warning>These endpoints are deprecated and will be removed in the future.</Warning>

get/v2/oauth-clients/{clientId}/users

Path parameters

clientIdstring required

Query parameters

limitnumber
Example:10

The number of items to return

offsetnumber

The number of items to skip

emailsstring[]

Filter managed users by email. If you want to filter by multiple emails, separate them with a comma.

Headers

x-cal-secret-keystring required

OAuth client secret key

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "email": "alice+cluo37fwd0001khkzqqynkpj3@example.com",
      "username": "alice",
      "name": "alice",
      "bio": "bio",
      "timeZone": "America/New_York",
      "weekStart": "Sunday",
      "createdDate": "2024-04-01T00:00:00.000Z",
      "timeFormat": 12,
      "locale": "en",
      "avatarUrl": "https://cal.com/api/avatar/2b735186-b01b-46d3-87da-019b8f61776b.png",
      "metadata": {
        "key": "value"
      }
    }
  ]
}