API reference · v1
Attributes
Read a schema's attributes. Attributes are authored in the app.
List attributes
/v1/schemas/{schema}/attributesLists base attributes first, then custom attributes. Base ids use base:<key> and have null sequence and timestamps. definition.type uses the documented stored/evaluated types; aggregate is definition.valueSource.type, not a top-level type. Only definitions with type other than evaluated and no valueSource are writable. Definition metadata can include auto-fill settings, aggregate source configuration, or evaluated target/reference descriptions; generated expressions are excluded. Record GET/list does not expand evaluated or aggregate values. Attribute authoring is available in the app, not through public v1.
Path parameters
- Name
schema- Type
- string
- Requirement
- Required
- Description
- A schema id or slug.
Query parameters
- 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/students/attributes' \
-H "Authorization: Bearer $MAXCLICKS_API_KEY"Response
{
"data": [
{
"id": "attr_BcwDvBUeSaSDILA5tHgpmU7I",
"key": "string",
"label": "string",
"description": "string",
"sequence": "string",
"definition": {
"type": "string",
"nullable": false,
"multiLine": false,
"format": "string",
"jsonSchema": {},
"autoFill": {},
"valueSource": {},
"target": "schema",
"cardinality": "one",
"schemaId": "sch_BcwDvBUeSaSDILA5tHgpmU7I"
},
"integrationVendorName": "string",
"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 attributes.
- 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.