---
title: "List all client onboardings"
method: GET
path: "/ext/v2/client-onboardings/"
tags: ["Onboarding"]
---

# List all client onboardings

`GET /ext/v2/client-onboardings/`

## Request

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

This endpoint is available to Group API Keys only.

Returns a list of client onboarding records across all clinics in the organization. The onboardings are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.

A **client onboarding** tracks a new pet parent's setup process, including their subscriptions (recurring autoship orders), estimated annual value, and prescription status for each subscription.

## 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.
- `cursor` string, nullable: A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.
- `modified__gte` string, date-time, nullable: Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.
- `modified__lte` string, date-time, nullable: Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.
- `created__gte` string, date, nullable: When provided, filters to onboardings created on or after this date
- `created__lte` string, date, nullable: When provided, filters to onboardings created on or before this date

## Response `200`

OK

- ExternalClientOnboardingSchemaList
  - `data` ExternalClientOnboardingSchema[], required: A single page of data contained within this list.
    - `client_id` integer, required: ID of the client being onboarded
    - `clinic_id` integer, required: ID of the clinic handling the onboarding
    - `created` string, date-time, required: The datetime this object was created.
    - `has_payment_method` boolean, required: Indicates whether the client has a saved payment method in Vetcove Home Delivery
    - `id` integer, required: Unique identifier for the onboarding
    - `modified` string, date-time, required: The datetime this object was last modified; changes to related entities will not update this field.
    - `onboarding_events` ExternalOnboardingEventSchema[], nullable: List of events in the onboarding process
      - `created` string, date-time, required: Timestamp when the event was created
      - `kind` union, required: Type of onboarding event
        - 'LINK_SENDING' | 'REMINDER_LINK_SENDING' | 'LINK_SENT' | 'LINK_FAILED_TO_SEND' | 'LINK_OPENED' | 'LINK_SUBMITTED' | 'CALLED' | 'SCHEDULED' | 'LEGACY_PHARMACY_LINK_CLICKED' | 'NOTE'
        - ''
      - `note` string, nullable: Additional notes about the event
    - `onboarding_status` string, nullable: The status of the onboarding event
    - `subscription_message_sent_at` string, date-time, nullable: Timestamp when subscription message was sent
    - `subscriptions` ExternalClientOnboardingSubscriptionSchema[], required: List of subscriptions associated with the onboarding
      - `estimated_value_annual` integer, nullable: The estimated annualized value associated with the onboarding
      - `frequency` string, nullable: Display name of the frequency
      - `id` integer, required: Unique identifier for the subscription
      - `item` string, required: Name of the item being subscribed to
      - `next_order_date` string, date-time, nullable: Date of the next order
      - `original_rx_status` string, required: The original status of the prescription upon import
      - `patient_id` integer, required: ID of the patient being subscribed to
      - `rx_status` string, required: The status of the prescription
      - `status` 'ACTIVE' | 'CANCELED_VIA_CLINIC' | 'CANCELED_VIA_CLIENT' | 'CANCELED_DENIED' | 'CANCELED_VIA_ADMIN' | 'FAILED_PAYMENT' | 'PAUSED_VIA_CLIENT' | 'PAUSED_VIA_CLINIC' | 'PAUSED_BAD_ADDRESS' | 'PAUSED_PRESCRIPTION' | 'PAUSED_OUT_OF_STOCK' | 'PAUSED_MISSING_CLIENT_INFO' | 'PAUSED_FLAVOR_UNAVAILABLE' | 'PAUSED_OTHER' | 'IMPORTED', required
  - `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)