Orgs / Users

Get all users

get/v2/organizations/{orgId}/users

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdnumber required

Query parameters

takenumber
Example:10

The number of items to return

skipnumber

The number of items to skip

emailsstring[]

The email address or an array of email addresses to filter by

[
  "user1@example.com",
  "user2@example.com"
]
assignedOptionIdsstring[]

Filter by assigned attribute option ids. ids must be separated by a comma.

attributeQueryOperator'OR' | 'AND' | 'NONE'
Example:NONE

Query operator used to filter assigned options, AND by default.

teamIdsnumber[]

Filter by teamIds. Team ids must be separated by a comma.

Headers

Authorizationstring

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-keystring

For platform customers - OAuth client secret key

x-cal-client-idstring

For platform customers - OAuth client ID

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "username": "john_doe",
      "name": "John Doe",
      "email": "john@example.com",
      "emailVerified": "2022-01-01T00:00:00Z",
      "bio": "I am a software developer",
      "avatarUrl": "https://example.com/avatar.jpg",
      "timeZone": "America/New_York",
      "weekStart": "Monday",
      "appTheme": "light",
      "theme": "default",
      "defaultScheduleId": 1,
      "locale": "en-US",
      "timeFormat": 12,
      "brandColor": "#ffffff",
      "darkBrandColor": "#000000",
      "allowDynamicBooking": true,
      "createdDate": "2022-01-01T00:00:00Z",
      "verified": true,
      "invitedTo": 1,
      "metadata": {
        "key": "value"
      },
      "profile": {
        "id": 1,
        "organizationId": 1,
        "userId": 1,
        "username": "john_doe"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.