List Groups

GET

https://api.calendly.com/groups

GET

/groups

1 import { CalendlyClient } from "calendly";
2 
3 async function main() {
4     const client = new CalendlyClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.groups.listGroups({
8         organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
9     });
10 }
11 main();

1 {
2   "collection": [
3     {
4       "uri": "https://api.calendly.com/groups/AAAAAAAAAAAAAAAA",
5       "name": "Sales Team",
6       "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
7       "created_at": "2019-01-02T03:04:05.678123Z",
8       "updated_at": "2019-08-07T06:05:04.321123Z",
9       "member_count": 1.1
10     }
11   ],
12   "pagination": {
13     "count": 20,
14     "next_page": "https://api.calendly.com/event_types?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
15     "previous_page": "https://api.calendly.com/event_types?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
16     "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
17     "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
18   }
19 }

Returns a list of groups.

Required scopes

groups:read

Returns a list of groups. <Info title="Required scopes"> > `groups:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

organizationstringRequiredformat: "uri"

Return groups that are associated with the organization associated with this URI

page_tokenstringOptional

The token to pass to get the next or previous portion of the collection

countintegerOptional1-100Defaults to 20

The number of rows to return

Response

collectionlist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error