---
title: "List checkout links"
method: GET
path: "/ext/v2/checkout-links/"
tags: ["Checkout Links"]
---

# List checkout links

`GET /ext/v2/checkout-links/`

## Request

- Base URL: `https://connect.vetcove.com`
- URL: `https://connect.vetcove.com/ext/v2/checkout-links/`
- Auth: HTTP bearer

Returns a list of checkout links for a clinic. The checkout links are sorted by creation date, with the most recent appearing first.

A **checkout link** is a unique URL sent to a pet parent (clinic client) that allows them to complete a purchase online. Each checkout link is associated with a specific clinic and client, and tracks whether the link has been opened and the communication method used to deliver it (e.g., SMS, email).

## Query parameters

- `ids` integer[], nullable: When provided, filters to objects with these IDs.
- `ending_before` integer, nullable: A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.
- `starting_after` integer, nullable: A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.
- `limit` integer: The maximum number of items to return per page.
- `clinic_id` integer, required: Required. Filters to checkout links for this clinic
- `clinic_client_id` integer, nullable: When provided, filters to checkout links for this clinic client
- `start_date__gte` string, nullable: When provided, filters to checkout links sent on or after this date. This will be translated to a datetime representing the start of the day in the clinic's timezone. Format: YYYY-MM-DD
- `end_date__lte` string, nullable: When provided, filters to checkout links sent on or prior to this date. This will be translated to a datetime representing the end of the day in the clinic's timezone. Format: YYYY-MM-DD

## Response `200`

OK

- ExternalCheckoutLinkSchemaList
  - `data` ExternalCheckoutLinkSchema[], required: A single page of data contained within this list.
    - `acting_user` string, nullable: The name of the person who sent this checkout link. If null, then the link was system generated.
    - `cart_id` integer, required: The ID of the cart associated with this checkout link.
    - `clinic_client_id` integer, nullable, required: The ID of the clinic client this checkout link was sent to.
    - `clinic_id` integer, required: The ID of the clinic for this checkout link.
    - `communication_methods` string[]: The methods through which this checkout link was sent.
    - `id` integer, required: The unique identifier for the checkout link.
    - `order_id` integer, nullable, required: The ID of the order that was placed as a result of this checkout
    - `sent_at` string, date-time, required: When this checkout link was sent.
    - `sms_body` string, nullable: The body of the SMS message sent for this checkout link, if sent via text.
  - `has_more` boolean: Whether there are more pages or data in this list.
  - `next_page` string, required: A URL linking to the next page of this list.
  - `type` string: Type of this object. Always `list`.

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)