Get an object schema
https://email.growthdept.ai/api/object-schemas/{id}Rate limits
Scopes
custom-objects:read
Operation id
get_object_schema The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 5 fields
typestringrequired
object-schemaidstringrequired
attributesobjectrequired
attributes: 7 fields
titlestringrequired
descriptionstringrequired
statusstringrequired
activedraftpublishingundefinedpropertiesarray of objectsrequired
properties: 4 fields
idintegerrequired
namestringrequired
typestringrequired
booleanfloatintlist_strstringtimestampdescriptionstringcan be null
requiredarray of stringsrequired
published_atstring (date-time)can be null
visibilitystringrequired
privateshared
relationshipsobject
relationships: 3 fields
source-mappingobject
source-mapping: 2 fields
dataobject
data: 2 fields
typestringrequired
source-mappingidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
object-schemasobject
object-schemas: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
object-schemaidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
profile-object-schemasobject
profile-object-schemas: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
profile-object-schemaidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
includedarray of objects
One option: ObjectSchemaRelationshipResponseObjectResource
typestringrequired
object-schemaidstringrequired
linksobjectrequired
links: 1 field
selfstring (uri)required
metaobjectcan be null
meta: 3 fields
relationship_idstringrequired
namestringrequired
descriptionstringcan be null
One option: SourceMappingResponseObjectResource
typestringrequired
source-mappingidstringrequired
attributesobjectrequired
attributes: 2 fields
property_mappingsarray of objectsrequired
One option: ConstantPropertyMapping
idintegerrequired
typestringrequired
constantvalueone ofrequired
One option: integer
No fields.
One option: number
No fields.
One option: string
No fields.
One option: boolean
No fields.
One option: SimplePropertyMapping
idintegerrequired
typestringrequired
simplesourceobjectrequired
source: 3 fields
source_idstringrequired
id_pathstringrequired
data_pathstringrequired
relationship_mappingsarray of objectsrequired
relationship_mappings: 3 fields
relationship_idstringrequired
typestringrequired
simplesourceone ofrequired
One option: CustomObjectRelationshipSource
source_idstringrequired
typestringrequired
custom-objectid_pathstringrequired
related_id_pathstringrequired
update_strategystringcan be null
additivereplace_from_origin
One option: ProfileRelationshipSource
source_idstringrequired
typestringrequired
profileid_pathstringrequired
related_id_pathsarray of objectsrequired
related_id_paths: 2 fields
identifier_typestringrequired
anonymousemailexternal-idklaviyo-idphonepathstringrequired
update_strategystringcan be null
additivereplace_from_origin
linksobjectrequired
links: 1 field
selfstring (uri)required
One option: ProfileObjectSchemaRelationshipResponseObjectResource
typestringrequired
profile-object-schemaidstringrequired
linksobjectrequired
links: 1 field
selfstring (uri)required
metaobjectcan be null
meta: 3 fields
relationship_idstringrequired
namestringrequired
descriptionstringcan be null
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject