Close Scheduling Links API

The scheduling_links API from Close — 8 operation(s) for scheduling_links.

Documentation GitHub OpenAPI

Operations 14

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /scheduling_link/ List my personal scheduling links · List User Scheduling Links #

Ask an LLM

“Which personal booking links do I have set up in Close?”

“Can I see all of my own user scheduling links in one list?”

Tell an agent

List all of my user scheduling links.

Show me every personal meeting booking link I've created.

POST /scheduling_link/ Create a personal scheduling link · Create a User Scheduling Link #

Ask an LLM

“How do I add a new personal booking link for my meetings?”

“Can I register my own calendar booking URL as a user scheduling link?”

Tell an agent

Create a new user scheduling link for me.

Add a personal scheduling link so prospects can book time with me.

POST /scheduling_link/integration/ Upsert a scheduling link from an OAuth app · Create or update a Scheduling Link via OAuth #

Ask an LLM

“Can my OAuth integration create or update a user's scheduling link by its source id?”

“What happens if my app pushes a scheduling link with a source id that already exists?”

Tell an agent

Sync my OAuth app's scheduling link into Close, creating it or updating the one with the same source id.

Upsert an integration-managed user scheduling link through the OAuth app.

DELETE /scheduling_link/integration/{source_id}/ Delete an OAuth app's scheduling link by source id · Delete a User Scheduling Link via OAuth integration #

Ask an LLM

“Can my OAuth app remove a scheduling link it created using its own source id?”

“Which call deletes an integration-managed scheduling link rather than one I made by hand?”

Tell an agent destructive · confirm first

Delete the integration scheduling link with source id {source_id}.

Remove the OAuth-managed booking link {source_id} from Close.

GET /scheduling_link/{id}/ Fetch one personal scheduling link · Fetch a User Scheduling Link #

Ask an LLM

“What are the details of a specific user scheduling link?”

“Can I look up one of my booking links by its id?”

Tell an agent

Fetch user scheduling link {id}.

Show me the details of my personal booking link {id}.

PUT /scheduling_link/{id}/ Update a personal scheduling link · Update a User Scheduling Link #

Ask an LLM

“Can I change the name or URL of an existing personal booking link?”

“Is it possible to edit a user scheduling link after creating it?”

Tell an agent

Update my user scheduling link {id}.

Edit personal booking link {id} with the new details.

DELETE /scheduling_link/{id}/ Delete a personal scheduling link · Delete a User Scheduling Link #

Ask an LLM

“Can I remove one of my own booking links that I no longer use?”

“What's the way to delete a user scheduling link I created manually?”

Tell an agent destructive · confirm first

Delete user scheduling link {id}.

Remove my personal booking link {id}.

GET /shared_scheduling_link/ List team shared scheduling links · List Shared Scheduling Links #

Ask an LLM

“Which shared scheduling links exist for my team?”

“Can I see all organization-wide booking links?”

Tell an agent

List all shared scheduling links.

Show the team's shared booking links.

POST /shared_scheduling_link/ Create a shared scheduling link · Create a Shared Scheduling Link #

Ask an LLM

“How do I create a booking link that the whole team can use?”

“Can I set up a shared scheduling link for my organization?”

Tell an agent

Create a new shared scheduling link for the team.

Add an organization-wide shared booking link.

GET /shared_scheduling_link/{id}/ Fetch one shared scheduling link · Fetch a Shared Scheduling Link #

Ask an LLM

“What does a particular shared scheduling link point to?”

“Can I retrieve a team booking link by its id?”

Tell an agent

Fetch shared scheduling link {id}.

Show details for the team booking link {id}.

PUT /shared_scheduling_link/{id}/ Update a shared scheduling link · Update a Shared Scheduling Link #

Ask an LLM

“Can I rename or change a shared team booking link?”

“Is it possible to edit a shared scheduling link after it's created?”

Tell an agent

Update shared scheduling link {id}.

Edit the team booking link {id} with the new settings.

DELETE /shared_scheduling_link/{id}/ Delete a shared scheduling link · Delete a Shared Scheduling Link #

Ask an LLM

“Can I remove a shared booking link the team no longer uses?”

“What happens when I delete a shared scheduling link?”

Tell an agent destructive · confirm first

Delete shared scheduling link {id}.

Remove the team booking link {id}.

POST /shared_scheduling_link_association/ Map a shared link to a user link or URL · Map a Shared Scheduling Link #

Ask an LLM

“Can I point a shared scheduling link at a specific user's booking link?”

“Is it possible to map a shared scheduling link to a plain URL instead?”

Tell an agent

Map a shared scheduling link to a user's personal scheduling link.

Associate the shared booking link with a custom URL.

POST /shared_scheduling_link_association/unmap/ Unmap a shared scheduling link · Unmap a Shared Scheduling Link #

Ask an LLM

“Can I undo the mapping between a shared scheduling link and a user's link?”

“What's the way to detach a shared booking link from where it currently points?”

Tell an agent destructive · confirm first

Unmap the shared scheduling link from its user link or URL.

Remove the association on a shared booking link.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/close/refs/heads/main/openapi/close-scheduling-links-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/close:close-scheduling-links-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: Close CRM REST API
  title: Close Scheduling Links API
  version: 1.0.0
servers:
- url: https://api.close.com/api/v1
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Scheduling Links
  externalDocs:
    url: https://developer.close.com/api/resources/scheduling-links
paths:
  /scheduling_link/:
    get:
      operationId: scheduling_links_list
      tags:
      - Scheduling Links
      summary: List User Scheduling Links
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                - description: Description of Example Scheduling Link
                  duration_in_minutes: null
                  id: schlnk_2xfNHpU6cjThMuhioZ3GjX
                  name: Example Scheduling Link
                  oauth_client_id: null
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  source: MANUAL
                  source_id: null
                  source_type: null
                  template_tag: null
                  type: USER
                  url: https://example.com/schedule
                  user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                - description: Let's find a time to meet!
                  duration_in_minutes: 60
                  id: schlnk_2xfNHpU6cjThMuhioZ3GjX
                  name: Chat with Us
                  oauth_client_id: oa2client_5NvOjgHYKHkbBjv5Rmiyfp
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  source: THIRD_PARTY
                  source_id: 74241bb7-3436-4228-9b76-392ef7a443ee
                  source_type: Multi-Use
                  template_tag: null
                  type: USER
                  url: https://your-app.example.com/link/example/
                  user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                - description: null
                  duration_in_minutes: 30
                  id: schlnk_6R2iZqSRXk1ZPLXXqn83LB
                  name: 30 Minute Meeting
                  oauth_client_id: null
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  source: CALENDLY
                  source_id: fe722374-9993-45f7-8c4c-c2004ec78940
                  source_type: Solo
                  template_tag: null
                  type: USER
                  url: https://calendly.com/username/30min
                  user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                has_more: false
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      operationId: scheduling_links_create
      tags:
      - Scheduling Links
      summary: Create a User Scheduling Link
      requestBody:
        content:
          application/json:
            example:
              description: Description of Example Scheduling Link
              name: Example Scheduling Link
              url: example.com/schedule
        required: true
      responses:
        '201':
          content:
            application/json:
              example:
                description: Description of Example Scheduling Link
                duration_in_minutes: null
                id: schlnk_2xfNHpU6cjThMuhioZ3GjX
                name: Example Scheduling Link
                oauth_client_id: null
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                source: MANUAL
                source_id: null
                source_type: null
                template_tag: null
                type: USER
                url: https://example.com/schedule
                user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /scheduling_link/integration/:
    post:
      operationId: scheduling_links_create_integration
      tags:
      - Scheduling Links
      summary: Create or update a Scheduling Link via OAuth
      description: 'Please note that only OAuth apps can perform this operation. Using API key will result in an error. See Authentication with OAuth for more information.


        Create or update a user scheduling link, managed by your application. Uses the integration-provided `source_id` field to identify and merge duplicate resources created by the same OAuth Application. If a scheduling link created by your OAuth application with the specified `source_id` does not exist, a new one will be created. Otherwise, the scheduling link resource will be updated. Requires authentication via OAuth.'
      requestBody:
        content:
          application/json:
            example:
              description: Let's find a time to meet!
              duration_in_minutes: 60
              name: Chat with Us
              source_id: 74241bb7-3436-4228-9b76-392ef7a443ee
              source_type: Multi-Use
              url: https://your-app.example.com/link/example/
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                description: Let's find a time to meet!
                duration_in_minutes: 60
                id: schlnk_2xfNHpU6cjThMuhioZ3GjX
                name: Chat with Us
                oauth_client_id: oa2client_5NvOjgHYKHkbBjv5Rmiyfp
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                source: THIRD_PARTY
                source_id: 74241bb7-3436-4228-9b76-392ef7a443ee
                source_type: Multi-Use
                template_tag: null
                type: USER
                url: https://your-app.example.com/link/example/
                user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /scheduling_link/integration/{source_id}/:
    delete:
      operationId: scheduling_links_delete_integration
      tags:
      - Scheduling Links
      summary: Delete a User Scheduling Link via OAuth integration
      description: 'Please note that only OAuth apps can perform this operation. Using API key will result in an error. See Authentication with OAuth for more information.


        Uses the `source_id` field to identify and delete the specified User Scheduling Link created by your OAuth Application.'
      parameters:
      - in: path
        name: source_id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /scheduling_link/{id}/:
    get:
      operationId: scheduling_links_get
      tags:
      - Scheduling Links
      summary: Fetch a User Scheduling Link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                description: Description of Example Scheduling Link
                duration_in_minutes: null
                id: schlnk_2xfNHpU6cjThMuhioZ3GjX
                name: Example Scheduling Link
                oauth_client_id: null
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                source: MANUAL
                source_id: null
                source_type: null
                template_tag: null
                type: USER
                url: https://example.com/schedule
                user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    put:
      operationId: scheduling_links_update
      tags:
      - Scheduling Links
      summary: Update a User Scheduling Link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              description: Updated Scheduling Link description
              name: Updated Scheduling Link name
              url: example.com/updated
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                description: Updated Scheduling Link description
                duration_in_minutes: null
                id: schlnk_2xfNHpU6cjThMuhioZ3GjX
                name: Updated Scheduling Link name
                oauth_client_id: null
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                source: MANUAL
                source_id: null
                source_type: null
                template_tag: null
                type: USER
                url: https://example.com/updated
                user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    delete:
      operationId: scheduling_links_delete
      tags:
      - Scheduling Links
      summary: Delete a User Scheduling Link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /shared_scheduling_link/:
    get:
      operationId: scheduling_links_list_shared
      tags:
      - Scheduling Links
      summary: List Shared Scheduling Links
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                - description: Shared Scheduling Link description
                  duration_in_minutes: null
                  id: schlnk_167Y0qg1idTVbr6wUoDUlO
                  name: Another Shared Scheduling Link Name
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  source: MANUAL
                  source_id: null
                  source_type: null
                  template_tag: another_shared_scheduling_link_name
                  type: SHARED
                  url: null
                  user_id: null
                - description: Shared Scheduling Link description
                  duration_in_minutes: null
                  id: schlnk_5KRTvFoioQKyQjDRFEDvp6
                  name: Shared Scheduling Link name
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  source: MANUAL
                  source_id: null
                  source_type: null
                  template_tag: scheduling_link_name
                  type: SHARED
                  url: null
                  user_id: null
                has_more: false
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      operationId: scheduling_links_create_shared
      tags:
      - Scheduling Links
      summary: Create a Shared Scheduling Link
      requestBody:
        content:
          application/json:
            example:
              name: Name
              description: Description
        required: true
      responses:
        '201':
          content:
            application/json:
              example:
                description: Description
                duration_in_minutes: null
                id: schlnk_3knjle4iOiymsYjiJHZraq
                name: Name
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                source: MANUAL
                source_id: null
                source_type: null
                template_tag: name
                type: SHARED
                url: null
                user_id: null
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /shared_scheduling_link/{id}/:
    get:
      operationId: scheduling_links_get_shared
      tags:
      - Scheduling Links
      summary: Fetch a Shared Scheduling Link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                description: Description
                duration_in_minutes: null
                id: schlnk_3knjle4iOiymsYjiJHZraq
                name: Name
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                source: MANUAL
                source_id: null
                source_type: null
                template_tag: name
                type: SHARED
                url: null
                user_id: null
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    put:
      operationId: scheduling_links_update_shared
      tags:
      - Scheduling Links
      summary: Update a Shared Scheduling Link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              description: new Shared Scheduling Link name
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                description: new Shared Scheduling Link name
                duration_in_minutes: null
                id: schlnk_6dCC3HFuQMD4PRbzCG9GyG
                name: Shared Scheduling Link name
                organization_id: orga_oBdWXGyTzf0eRhvDX3mZkCZ9gatoqndE8wkwZW9pQc5
                source: MANUAL
                source_id: null
                source_type: null
                template_tag: scheduling_link_name
                type: SHARED
                url: null
                user_id: null
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    delete:
      operationId: scheduling_links_delete_shared
      tags:
      - Scheduling Links
      summary: Delete a Shared Scheduling Link
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /shared_scheduling_link_association/:
    post:
      operationId: scheduling_links_create_shared_association
      tags:
      - Scheduling Links
      summary: Map a Shared Scheduling Link
      description: 'Map a Shared Scheduling Link to either a User Scheduling Link or a URL.


        See the examples below for both mapping options.'
      requestBody:
        content:
          application/json:
            examples:
              mapToUserSchedulingLink:
                description: Map a Shared Scheduling Link to a specific user's scheduling link.
                summary: Map to User Scheduling Link
                value:
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  shared_scheduling_link_id: schlnk_5VhB72iVnX3NAn3XJ0o9Ph
                  user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                  user_scheduling_link_id: schlnk_6m84x0gYn3eSSRJg8sfSQX
              mapToUrl:
                description: Map a Shared Scheduling Link to an external URL.
                summary: Map to URL
                value:
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                  shared_scheduling_link_id: schlnk_5VhB72iVnX3NAn3XJ0o9Ph
                  url: example.com
                  user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                mapToUserSchedulingLink:
                  description: Map a Shared Scheduling Link to a specific user's scheduling link.
                  summary: Map to User Scheduling Link
                  value:
                    organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                    shared_scheduling_link_id: schlnk_5VhB72iVnX3NAn3XJ0o9Ph
                    url: null
                    user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                    user_scheduling_link_id: schlnk_6m84x0gYn3eSSRJg8sfSQX
                mapToUrl:
                  description: Map a Shared Scheduling Link to an external URL.
                  summary: Map to URL
                  value:
                    organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                    shared_scheduling_link_id: schlnk_5VhB72iVnX3NAn3XJ0o9Ph
                    url: https://example.com
                    user_id: null
                    user_scheduling_link_id: schlnk_6m84x0gYn3eSSRJg8sfSQX
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /shared_scheduling_link_association/unmap/:
    post:
      operationId: scheduling_links_delete_shared_association
      tags:
      - Scheduling Links
      summary: Unmap a Shared Scheduling Link
      requestBody:
        content:
          application/json:
            example:
              organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
              shared_scheduling_link_id: schlnk_5VhB72iVnX3NAn3XJ0o9Ph
              user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
        required: true
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  securitySchemes:
    ApiKeyAuth:
      description: Use your API key as the username and leave the password empty.
      scheme: basic
      type: http
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://app.close.com/oauth2/authorize/
          scopes:
            all.full_access: Full access to all resources
            offline_access: Request a refresh token
          tokenUrl: https://api.close.com/oauth2/token/
      type: oauth2