SAsavvycal
Scheduling Links

List scheduling links

get/v1/links

Request

Query parameters

limitinteger
afterstring

Returns the entries after this cursor, from metadata.after in a previous response.

beforestring

Returns the entries before this cursor, from metadata.before in a previous response.

state'active' | 'pending' | 'disabled' | 'archived'

Without a state, returns active, pending, and disabled links.

scopestring

A scope ID, or any for every scope. A value that isn't the ID of an active scope returns a 400.

qstring

Search text. Each word must match the link's name, private name, description, slug, or scope slug.

Response

Success

Example response

{
  "entries": [
    {
      "default_duration": 30,
      "description": "<p>A brief meeting to discuss your needs</p>",
      "durations": [
        15,
        30,
        45
      ],
      "fields": [
        {
          "id": "field_123",
          "is_required": true,
          "label": "Company",
          "options": [],
          "type": "short_text"
        }
      ],
      "id": "link_01J5KC2G3MHPCECSQ6KM6FMDPC",
      "increment": 15,
      "name": "30 Minute Meeting",
      "private_name": "Quick sync with prospects",
      "scope": {
        "id": "scope_01J5KC4R7NHQFGT8V2WD9Y8H6X",
        "name": "Sales Team",
        "slug": "sales"
      },
      "slug": "30min",
      "state": "active"
    }
  ],
  "metadata": {
    "after": "eyJpZCI6ImxpbmtfYWJjMTIzIn0",
    "before": null,
    "limit": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.