API reference · v1
Schemas
Manage the space's schemas (contact, object, event).
List schemas
GET
/v1/schemasLists the space's schemas, optionally filtered by type.
Query parameters
- Name
type- Type
- string[]
- Description
- Filter by one or more schema types. Repeat the parameter to pass several.
- Name
limit- Type
- integer
- Description
- Page size. Clamped to 1..200 with a warning if out of range.
- Name
offset- Type
- integer
- Description
- Rows to skip. Negative values clamp to 0 with a warning; above 10000 returns 400 offset_too_large. pagination.hasMore becomes false when the next offset reaches the cap even if totalCount is larger. Records list has no ad-hoc filter; this is not an unlimited export contract.
Request
curl --fail-with-body 'https://api.maxclicks.ai/v1/schemas' \
-H "Authorization: Bearer $MAXCLICKS_API_KEY"Response
{
"data": [
{
"id": "sch_BcwDvBUeSaSDILA5tHgpmU7I",
"type": "contact",
"slug": "string",
"name": "string",
"namePlural": "string",
"description": "string",
"integrationVendorName": "string",
"attributeCount": 0,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
],
"pagination": {
"limit": 0,
"offset": 0,
"totalCount": 0,
"hasMore": false
},
"warnings": []
}Status codes
- 200A page of schemas.
- 400The request was malformed or failed validation. Also covers
malformed_json(body is not valid JSON) and, on list endpoints,offset_too_large. - 401The API key is missing or invalid.
- 403The key lacks permission, or the space is out of scope.
- 429The rate limit was exceeded.
- 500The API failed to process a valid request.
Get a schema
GET
/v1/schemas/{schema}Fetches a single schema by id or slug.
Path parameters
- Name
schema- Type
- string
- Requirement
- Required
- Description
- A schema id or slug.
Request
curl --fail-with-body 'https://api.maxclicks.ai/v1/schemas/students' \
-H "Authorization: Bearer $MAXCLICKS_API_KEY"Response
{
"data": {
"id": "sch_BcwDvBUeSaSDILA5tHgpmU7I",
"type": "contact",
"slug": "string",
"name": "string",
"namePlural": "string",
"description": "string",
"integrationVendorName": "string",
"attributeCount": 0,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
},
"warnings": []
}Status codes
- 200The schema.
- 401The API key is missing or invalid.
- 403The key lacks permission, or the space is out of scope.
- 404The referenced resource was not found.
- 429The rate limit was exceeded.
- 500The API failed to process a valid request.
Working with these endpoints? See error handling, safe retries, client library guides, and the complete OpenAPI schema.