Retrieve a schema

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.

{ "schema": { "id": "6449c3f3-b68d-46d1-850b-c8aea998ce1b", "slug": "my-object", "visibility": "private", "labels": { "singular": "My Object", "plural": "My Objects" }, "description": "Sample Schema", "createdTimestamp": "2021-04-16T15:08:25.783751329Z", "updatedTimestamp": "2021-04-16T15:08:25.783751329Z", "fields": [ { "id": "my-number-field", "labels": { "singular": "Number", "plural": "Numbers" }, "type": "number", "required": false, "scale": 0 } ], "icons": { "default": "https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png" }, "relationships": [ { "id": "primary-contact", "labels": { "singular": "Primary Contact", "plural": "Primary Contacts" }, "description": "Primary contact to this object", "namespace": "contacts", "hasMany": false } ] } }
Path Params
string
required

Id of the Schema

Query Params
string
Defaults to all

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.

Responses

Language
Credentials
URL
Choose an example:
application/json