VEvetcove
Onboarding

List all client onboardings

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.

get/ext/v2/client-onboardings/

Request

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

Query parameters

idsinteger[] nullable

When provided, filters to objects with these IDs.

ending_beforeinteger 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_afterinteger 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.

limitinteger

The maximum number of items to return per page.

cursorstring 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__gtestring 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__ltestring 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__gtestring date nullable

When provided, filters to onboardings created on or after this date

created__ltestring date nullable

When provided, filters to onboardings created on or before this date

Response

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

No recorded changes to this operation across all 1 revision of this API.