curl --request GET \
--url https://api.cal.com/v2/organizations/{orgId}/organizations \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": [
{
"id": 123,
"name": "<string>",
"slug": "<string>",
"metadata": {
"key": "value"
}
}
],
"pagination": {
"totalItems": 123,
"remainingItems": 103,
"returnedItems": 10,
"itemsPerPage": 10,
"currentPage": 2,
"totalPages": 13,
"hasNextPage": true,
"hasPreviousPage": true
}
}Requires the user to have at least the ‘ORG_ADMIN’ role within the organization. Additionally, for platform, the plan must be ‘SCALE’ or higher to access this endpoint.
curl --request GET \
--url https://api.cal.com/v2/organizations/{orgId}/organizations \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": [
{
"id": 123,
"name": "<string>",
"slug": "<string>",
"metadata": {
"key": "value"
}
}
],
"pagination": {
"totalItems": 123,
"remainingItems": 103,
"returnedItems": 10,
"itemsPerPage": 10,
"currentPage": 2,
"totalPages": 13,
"hasNextPage": true,
"hasPreviousPage": true
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
For platform customers - OAuth client secret key
For platform customers - OAuth client ID
Maximum number of items to return
1 <= x <= 250Number of items to skip
x >= 0The slug of the managed organization
The key of the metadata - it is case sensitive so provide exactly as stored. If you provide it then you must also provide metadataValue
The value of the metadata - it is case sensitive so provide exactly as stored. If you provide it then you must also provide metadataKey
success, error "success"
Show child attributes
The total number of items available across all pages, matching the query criteria.
x >= 0123
The number of items remaining to be fetched after the current page. Calculated as: totalItems - (skip + itemsPerPage).
x >= 0103
The number of items returned in the current page.
10
The maximum number of items requested per page.
x >= 110
The current page number being returned.
x >= 12
The total number of pages available.
x >= 013
Indicates if there is a subsequent page available after the current one.
true
Indicates if there is a preceding page available before the current one.
true
Was this page helpful?