Get Group Relationship | Calendly | Developer Documentation

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

{
  "resource": {
    "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"
  }
}

Returns a group relationship by uuid

Required scopes

groups:read

Returns a group relationship by uuid <Info title="Required scopes"> > `groups:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Path parameters

uuidstringRequired

Response

resourceobject

A group relationship record for an individual. A given individual may have more than one admin relationship to multiple groups, but only one member relationship to a single group.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error