List Routing Forms | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.routingForms.listRoutingForms({
        organization: "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
    });
}
main();

{
  "collection": [
    {
      "uri": "https://api.calendly.com/routing_forms/AAAAAAAAAAAAAAAA",
      "organization": "https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA",
      "name": "ACME Demo",
      "status": "published",
      "questions": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "What is your industry?",
          "type": "select",
          "required": true,
          "answer_choices": [
            "IT & Software",
            "Financial Services",
            "Entertainment"
          ]
        },
        {
          "uuid": "1213f8f1-57fd-45ee-88e9-1978d35b5cad",
          "name": "Email",
          "type": "email",
          "required": true,
          "answer_choices": null
        }
      ],
      "created_at": "2022-05-15T03:04:05.678Z",
      "updated_at": "2022-05-15T06:05:04.321Z"
    }
  ],
  "pagination": {
    "count": 20,
    "next_page": "https://api.calendly.com/routing_forms?count=1&page_token=d8T0LKQ1XsC2utmPlI7TFPpHX4SSfoGl",
    "previous_page": "https://api.calendly.com/routing_forms?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H",
    "next_page_token": "d8T0LKQ1XsC2utmPlI7TFPpHX4SSfoGl",
    "previous_page_token": "VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H"
  }
}

Get a list of Routing Forms for a specified Organization.

Required scopes

routing_forms:read

Get a list of Routing Forms for a specified Organization. <Info title="Required scopes"> > `routing_forms:read` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Query parameters

organizationstringRequiredformat: "uri"

View organization routing forms associated with the organization's URI.

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

sortstringOptional

Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.

Response

collectionlist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error