retrieve_a_schema
Retrieve a specific custom object schema by its ID. Optionally include all fields, including deleted, using showFields parameter.
Instructions
🟢 READ-ONLY · Custom Objects · GET /customObjects/schemas/{id}
Retrieve a schema
Fetches data. Makes no changes to your ActiveCampaign account.
Retrieve a specific schema by id.
Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the Schema | |
| showFields | No | Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default. | all |