> ## Documentation Index > Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml get /ext/v2/client-onboardings/ openapi: 3.1.0 info: description: '' title: NinjaAPI version: 2.0.0 servers: - url: https://connect.vetcove.com/ security: [] paths: /ext/v2/client-onboardings/: get: tags: - Onboarding summary: List all client onboardings description: >- 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. operationId: client_onboarding parameters: - description: When provided, filters to objects with these IDs. in: query name: ids required: false schema: anyOf: - items: type: integer type: array - type: 'null' description: When provided, filters to objects with these IDs. title: Ids - description: >- 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`. in: query name: ending_before required: false schema: anyOf: - type: integer - type: 'null' description: >- 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`. title: Ending Before - description: >- 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`. in: query name: starting_after required: false schema: anyOf: - type: integer - type: 'null' description: >- 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`. title: Starting After - description: The maximum number of items to return per page. in: query name: limit required: false schema: default: 10 description: The maximum number of items to return per page. maximum: 100 minimum: 1 title: Limit type: integer - description: >- 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. in: query name: cursor required: false schema: anyOf: - type: string - type: 'null' description: >- 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. title: Cursor - description: >- 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. in: query name: modified__gte required: false schema: anyOf: - format: date-time type: string - type: 'null' description: >- 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. title: Modified Gte - description: >- 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. in: query name: modified__lte required: false schema: anyOf: - format: date-time type: string - type: 'null' description: >- 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. title: Modified Lte - description: When provided, filters to onboardings created on or after this date in: query name: created__gte required: false schema: anyOf: - format: date type: string - type: 'null' description: >- When provided, filters to onboardings created on or after this date title: Created Gte - description: When provided, filters to onboardings created on or before this date in: query name: created__lte required: false schema: anyOf: - format: date type: string - type: 'null' description: >- When provided, filters to onboardings created on or before this date title: Created Lte responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalClientOnboardingSchemaList' description: OK security: - ExternalAPIAuth: [] components: schemas: ExternalClientOnboardingSchemaList: properties: data: description: A single page of data contained within this list. items: $ref: '#/components/schemas/ExternalClientOnboardingSchema' title: Data type: array has_more: default: false description: Whether there are more pages or data in this list. title: Has More type: boolean next_page: description: A URL linking to the next page of this list. title: Next Page type: string type: default: list description: Type of this object. Always `list`. title: Type type: string required: - data - next_page title: ExternalClientOnboardingSchemaList type: object ExternalClientOnboardingSchema: properties: client_id: description: ID of the client being onboarded title: Client Id type: integer clinic_id: description: ID of the clinic handling the onboarding title: Clinic Id type: integer created: description: The datetime this object was created. format: date-time title: Created type: string has_payment_method: description: >- Indicates whether the client has a saved payment method in Vetcove Home Delivery title: Has Payment Method type: boolean id: description: Unique identifier for the onboarding title: Id type: integer modified: description: >- The datetime this object was last modified; changes to related entities will not update this field. format: date-time title: Modified type: string onboarding_events: anyOf: - items: $ref: '#/components/schemas/ExternalOnboardingEventSchema' type: array - type: 'null' description: List of events in the onboarding process title: Onboarding Events onboarding_status: anyOf: - type: string - type: 'null' description: The status of the onboarding event title: Onboarding Status subscription_message_sent_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp when subscription message was sent title: Subscription Message Sent At subscriptions: description: List of subscriptions associated with the onboarding items: $ref: '#/components/schemas/ExternalClientOnboardingSubscriptionSchema' title: Subscriptions type: array required: - created - modified - id - client_id - clinic_id - subscriptions - has_payment_method title: ExternalClientOnboardingSchema type: object ExternalOnboardingEventSchema: properties: created: description: Timestamp when the event was created format: date-time title: Created type: string kind: anyOf: - $ref: '#/components/schemas/OnboardingEventKind' - const: '' type: string description: Type of onboarding event title: Kind note: anyOf: - type: string - type: 'null' description: Additional notes about the event title: Note required: - kind - created title: ExternalOnboardingEventSchema type: object ExternalClientOnboardingSubscriptionSchema: properties: estimated_value_annual: anyOf: - type: integer - type: 'null' description: The estimated annualized value associated with the onboarding title: Estimated Value Annual frequency: anyOf: - type: string - type: 'null' description: Display name of the frequency title: Frequency id: description: Unique identifier for the subscription title: Id type: integer item: description: Name of the item being subscribed to title: Item type: string next_order_date: anyOf: - format: date-time type: string - type: 'null' description: Date of the next order title: Next Order Date original_rx_status: description: The original status of the prescription upon import title: Original Rx Status type: string patient_id: description: ID of the patient being subscribed to title: Patient Id type: integer rx_status: description: The status of the prescription title: Rx Status type: string status: $ref: '#/components/schemas/SubscriptionStatus' description: The status of the subscription. required: - id - item - patient_id - rx_status - original_rx_status - status title: ExternalClientOnboardingSubscriptionSchema type: object OnboardingEventKind: enum: - LINK_SENDING - REMINDER_LINK_SENDING - LINK_SENT - LINK_FAILED_TO_SEND - LINK_OPENED - LINK_SUBMITTED - CALLED - SCHEDULED - LEGACY_PHARMACY_LINK_CLICKED - NOTE title: OnboardingEventKind type: string SubscriptionStatus: enum: - 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 title: SubscriptionStatus type: string securitySchemes: ExternalAPIAuth: scheme: bearer type: http ````