GET v1/schemas

Beta Feature: This feature is currently in beta and restricted to approved users. If you're are interested in trying it, please contact support and we can enable this feature for your account.

The following endpoint allows you to list data schemas for your account in a paged list.

List data schemas

get

Retrieves a paginated list of data schemas.

Authorizations

API Key

X-API-KeystringRequired

Query parameters

pageSizeinteger · int32Optional

pageinteger · int32Optional

Responses

200

Payload of PagedResult containing DataSchema

application/json

total_pagesinteger · int32 · nullableOptional

The total number of pages available

total_recordsinteger · int32 · nullableOptional

The total number of records across all pages

pageinteger · int32 · nullableOptional

The page number to return (1-based)

Default: 1

page_sizeinteger · int32 · nullableOptional

The number of records to return per page

Default: 30

get

/v1/schemas

HTTPcURLJavaScriptPython

GET /v1/schemas HTTP/1.1
Host: api.gaffa.dev
X-API-Key: YOUR_API_KEY
Accept: */*

200

Payload of PagedResult containing DataSchema

{"data":{"total_pages":1,"total_records":3,"results":[{"id":"schema_abc123def456","name":"Customer Schema","description":"Data schema for customer information","fields":[{"type":"string","name":"firstName","description":"Customer's first name","fields":[]},{"type":"string","name":"lastName","description":"Customer's last name","fields":[]},{"type":"integer","name":"age","description":"Customer's age in years","fields":[]},{"type":"boolean","name":"isActive","description":"Whether the customer account is active","fields":[]}]},{"id":"schema_xyz789uvw123","name":"Product Schema","description":"Data schema for product information","fields":[{"type":"string","name":"productName","description":"Name of the product","fields":[]},{"type":"decimal","name":"price","description":"Product price","fields":[]},{"type":"boolean","name":"inStock","description":"Whether the product is in stock","fields":[]},{"type":"array","name":"tags","description":"Product tags","fields":[{"type":"string","name":"tagItem","description":null,"fields":[]}]}]},{"id":"schema_hij456klm789","name":"Order Schema","description":"Data schema for order processing","fields":[{"type":"string","name":"orderId","description":"Unique order identifier","fields":[]},{"type":"datetime","name":"orderDate","description":"Date when order was placed","fields":[]},{"type":"object","name":"customer","description":"Customer information","fields":[{"type":"string","name":"customerId","description":"Customer identifier","fields":[]},{"type":"string","name":"email","description":"Customer email address","fields":[]}]},{"type":"decimal","name":"totalAmount","description":"Total order amount","fields":[]}]}],"page":1,"page_size":30},"error":null}