> ## Documentation Index > Fetch the complete documentation index at: https://docs.jupico.com/llms.txt > Use this file to discover all available pages before exploring further. # List onboarding invites > Returns onboarding invites and their current status — created, sent, completed, or cancelled. ## OpenAPI ````yaml /openapi.json post /v1/query/onboardinginvites openapi: 3.0.0 info: title: Jupico - OpenAPI 3.0 description: >- The Jupico API lets Service Providers onboard merchants, process card and eCheck (ACH) payments, run hosted payment pages, manage recurring billing, send payouts, and query every resource. All endpoints use HTTPS with Basic authentication and accept and return JSON. Endpoints are grouped by workflow: onboard merchants first, then accept payments, then move funds and report. termsOfService: https://help.jupico.com/references-and-resources/legal contact: email: support@jupico.com license: name: Jupico License url: https://jupico.com version: 1.0.5 servers: - url: https://sandbox-platform.jupico.com security: - basicAuth: [] tags: - name: Status description: Health check for the Jupico API. - name: Onboarding Invites description: >- Create and send invites that onboard merchants through the Jupico-hosted flow, with optional pre-filled identity, fees, and payout bank account data. - name: Provisioning description: >- Onboard merchants from your own UI. Collect onboarding data and submit it through the provisioning chain: applicant → application → submerchant. - name: Session description: >- Create browser authorization sessions for the Jupico web components, so card and bank account data is tokenized client-side and never touches your servers. - name: Tokenization description: >- Convert one-time tokens from the web components into permanent Jupico tokens, or tokenize raw card data if your systems are PCI DSS compliant. - name: Customer description: >- Create and manage customer records that payments, subscriptions, installments, and invoices link to. - name: Card Transactions description: >- Process credit and debit card transactions using tokenized card data: sale, authorization, capture, void, refund, and rollback. - name: eCheck Transactions description: >- Debit customer bank accounts via eCheck (ACH): sale, void, refund, rollback, and bank account tokenization. - name: Checkouts description: >- Hosted checkout sessions where customers complete payment on a Jupico-hosted page. - name: Payment Links description: >- Shareable links that open a Jupico-hosted payment page — no integration code needed at the point of sharing. - name: Invoices description: Create and email invoices that customers pay online. - name: Subscriptions description: >- Recurring billing. Plans define billing schedules and pricing models; subscriptions enroll customers against a stored payment token. - name: Installments description: Split a fixed total into scheduled payments with an optional deposit. - name: Payouts description: >- Send funds from a submerchant's available balance to a tokenized bank account with on-demand payout instructions. - name: Query description: >- Search and report across every resource: transactions, merchants, settlements, balances, disputes, fees, and more. All query endpoints accept the same filter, sort, and pagination envelope — see the Query Capabilities guide. paths: /v1/query/onboardinginvites: post: tags: - Query summary: List onboarding invites description: >- Returns onboarding invites and their current status — created, sent, completed, or cancelled. operationId: findOnboardingInvites requestBody: required: true content: application/json: schema: type: object responses: '200': $ref: '#/components/responses/findOnboardingInvites' security: - basicAuth: [] components: responses: findOnboardingInvites: description: Find Onboarding invites content: application/json: schema: type: object properties: success: type: boolean description: >- Whether the request was processed successfully. Declines return HTTP 200 with `success: false`. count: type: number description: Number of records. data: type: array items: type: object properties: spProductId: type: string description: >- Identifier of the Service Provider product the merchant belongs to. inviteId: type: string description: Unique identifier of the onboarding invite. name: type: string description: Display name. email: type: string description: Email address. phoneNumber: type: string description: Phone number. reference: type: string description: Your own reference for this invite. url: type: string description: URL of the hosted page for this object. notifications: type: object properties: email: type: object properties: enabled: type: boolean description: Whether this setting is enabled. sent: type: boolean description: Whether the notification was sent. description: Email notification status. sms: type: object properties: enabled: type: boolean description: Whether this setting is enabled. sent: type: boolean description: Whether the notification was sent. description: SMS notification status. description: Delivery status of invite notifications. status: type: string description: Current status. feesTemplateId: type: string description: >- UUID of a fees template with predefined pricing. If omitted, the default template is used. onboardingFlowTemplateId: type: string example: '' description: >- UUID of the onboarding flow template that controls which steps the merchant sees. expiresAt: type: string format: date-time description: Timestamp when this object expires (ISO 8601). createdAt: type: string format: date-time description: Timestamp when the object was created (ISO 8601). updatedAt: type: string format: date-time description: Timestamp when the object was last updated (ISO 8601). description: The response payload. query: type: object properties: criteria: type: object description: Filter criteria applied, keyed by field path. options: type: object description: 'Query options: pagination, sorting, and field projection.' description: Echo of the query envelope that produced this result. securitySchemes: basicAuth: type: http scheme: basic ````