List Onboarding Providers¶

Cursor-paginated. ?npi= resolves an NPI to a provider id (at most one result, no cursor). next_cursor is absent on the final page.

Endpoint¶

GET /v2/onboarding/providers

Query Parameters¶

Parameter	Type	Required	Description
`npi`	string	No	Exact NPI match; returns at most one provider, no cursor
`query`	string	No	Free-text match on provider name
`clinic_id`	string	No	The clinic this record belongs to.
`limit`	integer	No	Page size. Defaults to 500, max 2000.
`cursor`	string	No	Opaque pagination cursor from a previous page's `next_cursor`.

Request¶

curl --location '{base_url}/v2/onboarding/providers' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

null

Error Response¶

Code: 400 Bad Request

{
  "code": "bad_request",
  "message": "Validation failed",
  "errors": [
    {
      "field": "patient_id",
      "message": "must be a string"
    }
  ]
}

Every error has the same shape — a machine-readable code, a message, and an errors[] array that's empty when there's nothing field-specific to report. The HTTP status is authoritative.

Status	`code`	Meaning
`400 Bad Request`	`bad_request`	The request body or parameters failed validation. `errors[]` names the offending fields.
`401 Unauthorized`	`unauthorized`	The access token is missing, malformed or expired.
`403 Forbidden`	`forbidden`	The request references a resource outside the token's organisation or clinic scope.
`404 Not Found`	`not_found`	No such resource, or it's outside your scope.
`429 Too Many Requests`	`rate_limited`	Rate limit exceeded. Back off and retry.
`500 Internal Server Error`	`internal_error`	Unexpected server error.
`502 Bad Gateway`	`upstream_error`	Upstream service failed or timed out.

Notes¶

Cursor-paginated, unlike the page/page_size pagination used elsewhere in v2.