---
title: "List booking links"
method: GET
path: "/v2/booking-links"
tags: ["Appointments.Booking Links"]
---

# List booking links

`GET /v2/booking-links`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/booking-links`
- Auth: API key in header `x-api-key`

List the self-booking links you've made for customers. Revoked links are left out unless you set includeRevoked=true.

## Query parameters

- `clientCustomerId` string, uuid
- `appointmentConfigId` string, uuid
- `includeRevoked` string

## Response `200`

GET /v2/booking-links Positive response

- GetV2BookingLinksPositiveResponse
  - `links` object[], required
    - `code` string, required
    - `clientCustomerId` string, uuid, nullable, required
    - `appointmentConfigId` string, uuid, required
    - `expiresAt` unknown, required
    - `revokedAt` unknown, required
    - `createdAt` unknown, required
    - `url` string, required

## Other responses

- `400`: GET /v2/booking-links Negative response 400
- `401`: GET /v2/booking-links Negative response 401
- `403`: GET /v2/booking-links Negative response 403
- `404`: GET /v2/booking-links Negative response 404
- `409`: GET /v2/booking-links Negative response 409
- `422`: GET /v2/booking-links Negative response 422
- `429`: GET /v2/booking-links Negative response 429
- `500`: GET /v2/booking-links Negative response 500
- `502`: GET /v2/booking-links Negative response 502
- `503`: GET /v2/booking-links Negative response 503

---

[API](https://skmtc.dev/carecycle/apis/carecycle-public-api.md) - [All operations](https://skmtc.dev/carecycle/apis/carecycle-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carecycle/apis/carecycle-public-api/revisions/db390c743c36?raw)