List Shares | Calendly | Developer Documentation

const url = 'https://api.calendly.com/shares?event_type=https%3A%2F%2Fapi.calendly.com%2Fevent_types%2FBBBBBBBBBBBBBBBB&max_created_at=2019-08-07T06%3A05%3A04.321123Z&min_created_at=2019-01-02T03%3A04%3A05.678123Z&sort=created_at%3Adesc&user=https%3A%2F%2Fapi.calendly.com%2Fusers%2FAAAAAAAAAAAAAAAA';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "collection": [
    {
      "uri": "https://api.calendly.com/shares/AAAAAAAAAAAAAAAA",
      "contact": "https://api.calendly.com/contacts/CCCCCCCCCCCCCCCC",
      "created_at": "2019-01-02T03:04:05.678123Z",
      "status": "active",
      "scheduling_links": [
        {
          "booking_url": "https://calendly.com/d/abcd-brv8/30-minute-meeting",
          "owner": "https://api.calendly.com/event_types/BBBBBBBBBBBBBBBB",
          "owner_type": "EventType"
        }
      ],
      "share_override": {
        "name": "30 Minute Meeting",
        "duration": 30,
        "duration_options": [
          30
        ],
        "period_type": "fixed",
        "start_date": "2026-10-08",
        "end_date": "2026-10-08",
        "max_booking_time": null,
        "min_booking_time": null,
        "hide_location": false,
        "location_configurations": [],
        "availability_rule": {
          "rules": [
            {
              "type": "wday",
              "intervals": [
                {
                  "from": "19:00",
                  "to": "20:00"
                }
              ],
              "wday": "thursday"
            }
          ],
          "timezone": "America/Los_Angeles"
        }
      }
    }
  ],
  "pagination": {
    "count": 1,
    "next_page": null,
    "previous_page": null,
    "next_page_token": null,
    "previous_page_token": null
  }
}

Returns the user’s Shares, newest first. Use it to find a Share created in an earlier session, for example to update or delete it.

The list matches the user’s Single-use links tab in the My Calendly view: user-managed Shares on Event Types the user owns or hosts, including one-off meetings. Like the tab, it leaves out disabled Shares, Shares created from meeting polls, and links booked through instant booking.

Required scopes

shares:read

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

userstringRequiredformat: "uri"

The URI of the user whose Shares should be returned. Must be the authenticated user. Another user returns 403.

min_created_atstringOptionalformat: "date-time"

Only Shares created at or after this time. ISO 8601, UTC.

max_created_atstringOptionalformat: "date-time"

Only Shares created before this time. ISO 8601, UTC.

event_typestringOptionalformat: "uri"

The URI of the Event Type. Return only Shares created from this Event Type. If the Event Type does not exist, the collection is empty.

sortenumOptionalDefaults to created_at:desc

Order results by creation time. Supported values: created_at:desc (default), created_at:asc.

Allowed values:

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

Response

collectionlist of objects

The set of shares matching the criteria

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error