Skip to main content
GET
/
api
/
v1
/
schemas
/
list
List Schemas
curl --request GET \
  --url https://api.invaro.ai/api/v1/api/v1/schemas/list \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "schemas": [
      {
        "id": "b3376c85-86e0-476e-aee9-5f05afaa05ea",
        "name": "invoice_schema_v1",
        "type": "invoice",
        "description": "Schema for parsing standard invoices",
        "version": 1,
        "is_active": true,
        "created_at": "2024-01-18T12:34:56Z",
        "updated_at": "2024-01-18T12:34:56Z"
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

​
Query Parameters

​
page
integer
default:"1"
Page number
​
page_size
integer
default:"20"
Items per page (max: 100)
​
type
string
Filter by schema type (“invoice” or “bank_statement”)

​
Response

Success Response (200)
{
  "success": true,
  "data": {
    "schemas": [
      {
        "id": "b3376c85-86e0-476e-aee9-5f05afaa05ea",
        "name": "invoice_schema_v1",
        "type": "invoice",
        "description": "Schema for parsing standard invoices",
        "version": 1,
        "is_active": true,
        "created_at": "2024-01-18T12:34:56Z",
        "updated_at": "2024-01-18T12:34:56Z"
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

​
Examples

​
List All Schemas

Curl
# List all schemas
curl "https://api.invaro.ai/api/v1/schemas/list" \
  -H "Authorization: Bearer your_api_key"

​
List with Pagination and Filtering

Curl
# List with pagination and filtering
curl "https://api.invaro.ai/api/v1/schemas/list?page=1&page_size=10&type=invoice" \
  -H "Authorization: Bearer your_api_key"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number

​
page_size
integer
default:20

Items per page

Required range: x <= 100
​
type
enum<string>

Filter by schema type

Available options:
invoice,
bank_statement

Response

200 - application/json

Schemas retrieved successfully

​
success
boolean
Example:

true

​
data
object