List health invoices
GET
/api/v1/workspaces/{workspaceId}/health-invoicesOperation ID: healthInvoices.list · Access: PAT with read scope and authorized workspace where applicable · Effect: read.
Read the health invoices workflow before this operation.
Parameters
Section titled “Parameters”| Name | In | Required | Type / allowed values |
|---|---|---|---|
workspaceId |
path | Yes | string |
page |
query | No | integer |
pageSize |
query | No | integer |
sortDirection |
query | No | asc, desc |
clientName |
query | No | string |
status |
query | No | string |
createdFrom |
query | No | string |
createdTo |
query | No | string |
includeArchived |
query | No | true, false |
sortBy |
query | No | invoiceNumber, clientName, status, createdAt, updatedAt, totalAmount |
invoiceNumber |
query | No | string |
submittedBy |
query | No | string |
totalMin |
query | No | number or null |
totalMax |
query | No | number or null |
Responses
Section titled “Responses”| HTTP | Content | Schema |
|---|---|---|
| 200 | application/json |
HealthInvoicePage |
| 400 | application/json |
ApiError |
| 401 | application/json |
ApiError |
| 403 | application/json |
ApiError |
| 404 | application/json |
ApiError |
| 500 | application/json |
ApiError |
Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.
Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.
curl --fail-with-body --request GET \ "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/health-invoices" \ --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \ --header 'Accept: application/json'