List Group Relationships | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.groups.listGroupRelationships({});
}
main();

{
  "collection": [
    {
      "uri": "https://api.calendly.com/group_relationships/AAAAAAAAAAAAAAAA",
      "role": "member",
      "owner": {
        "created_at": "2019-01-02T03:04:05.678123Z",
        "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
        "role": "user",
        "type": "OrganizationMembership",
        "updated_at": "2019-08-07T06:05:04.321123Z",
        "uri": "https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA",
        "user": {
          "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
          "created_at": "2019-01-02T03:04:05.678123Z",
          "email": "test@example.com",
          "locale": "en",
          "name": "John Doe",
          "scheduling_url": "https://calendly.com/acmesales",
          "slug": "acmesales",
          "time_notation": "12h",
          "timezone": "America/New York",
          "updated_at": "2019-08-07T06:05:04.321123Z",
          "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
        }
      },
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "group": "https://api.calendly.com/groups/AAAAAAAAAAAAAAAA",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z"
    },
    {
      "uri": "https://api.calendly.com/group_relationships/AAAAAAAAAAAAAAAA",
      "role": "admin",
      "owner": {
        "created_at": "2019-01-02T03:04:05.678123Z",
        "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
        "role": "user",
        "type": "OrganizationMembership",
        "updated_at": "2019-08-07T06:05:04.321123Z",
        "uri": "https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA",
        "user": {
          "avatar_url": "https://01234567890.cloudfront.net/uploads/user/avatar/0123456/a1b2c3d4.png",
          "created_at": "2019-01-02T03:04:05.678123Z",
          "email": "test@example.com",
          "locale": "en",
          "name": "John Doe",
          "scheduling_url": "https://calendly.com/acmesales",
          "slug": "acmesales",
          "time_notation": "12h",
          "timezone": "America/New York",
          "updated_at": "2019-08-07T06:05:04.321123Z",
          "uri": "https://api.calendly.com/users/AAAAAAAAAAAAAAAA"
        }
      },
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "group": "https://api.calendly.com/groups/AAAAAAAAAAAAAAAA",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z"
    },
    {
      "uri": "https://api.calendly.com/group_relationships/AAAAAAAAAAAAAAAA",
      "role": "member",
      "owner": {
        "created_at": "2019-08-07T06:05:04.321123Z",
        "email": "test@example.com",
        "last_sent_at": "2019-01-02T03:04:05.678123Z",
        "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
        "status": "pending",
        "type": "OrganizationInvitation",
        "updated_at": "2019-01-02T03:04:05.678123Z",
        "uri": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB"
      },
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "group": "https://api.calendly.com/groups/AAAAAAAAAAAAAAAA",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "updated_at": "2019-08-07T06:05:04.321123Z"
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://api.calendly.com/group_relationships?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page": "https://api.calendly.com/group_relationships?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  }
}

Returns a list of group relationships - a given owner can have one membership record, but multiple admin records

Required scopes

groups:read

Returns a list of group relationships - a given owner can have one membership record, but multiple admin records <Info title="Required scopes"> > `groups:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

countintegerOptional1-100Defaults to 20

The number of rows to return

page_tokenstringOptional

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

organizationstringOptionalformat: "uri"

Indicates the results should be filtered by organization

ownerstringOptionalformat: "uri"

Indicates the results should be filtered by owner
One Of:

Organization Membership URI - https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA
Organization Invitation URI - https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB

Indicates the results should be filtered by owner <br> One Of: - Organization Membership URI - `https://api.calendly.com/organization_memberships/AAAAAAAAAAAAAAAA` - Organization Invitation URI - `https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA/invitations/BBBBBBBBBBBBBBBB`

groupstringOptionalformat: "uri"

Indicates the results should be filtered by group

Response

collectionlist of objects

The set of group relationship records matching the criteria

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error