Opero APICustom Objects
Get custom object schema
Returns schema-builder context scoped to one custom object.
Authorization
api-token AuthorizationBearer <token>
Opero API token. Send it as Authorization: Bearer ek_...
In: header
Path Parameters
moduleKey*string
objectKey*string
Query Parameters
mode?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/custom-modules/string/objects/string/schema"{ "data": { "module": { "id": "string", "key": "string", "name": "string", "description": "string", "icon": "string", "color": "string", "isActive": true, "isHidden": true }, "objects": [ { "id": "string", "key": "string", "name": "string", "namePlural": "string", "kind": "REGULAR", "isActive": true, "isHidden": true, "isSingleton": true, "icon": "string", "color": "string", "displayLabel": "string", "contentSourceLanguage": "en", "recordCount": 0, "fields": [ { "id": "string", "key": "string", "name": "string", "type": "TEXT", "isIndexed": true, "defaultValue": "string", "localizable": true, "options": {}, "position": 0 } ], "incomingReferences": [ { "id": "string", "type": "string", "fieldId": "string", "fromObjectId": "string", "fromObjectKey": "string", "fromModuleKey": "string", "toObjectId": "string", "toObjectKey": "string", "toModuleKey": "string" } ], "outgoingReferences": [ { "id": "string", "type": "string", "fieldId": "string", "fromObjectId": "string", "fromObjectKey": "string", "fromModuleKey": "string", "toObjectId": "string", "toObjectKey": "string", "toModuleKey": "string" } ] } ], "schemaHash": "string", "operation": {}, "object": { "id": "string", "key": "string", "name": "string", "namePlural": "string", "kind": "REGULAR", "isActive": true, "isHidden": true, "isSingleton": true, "icon": "string", "color": "string", "displayLabel": "string", "contentSourceLanguage": "en", "recordCount": 0, "fields": [ { "id": "string", "key": "string", "name": "string", "type": "TEXT", "isIndexed": true, "defaultValue": "string", "localizable": true, "options": {}, "position": 0 } ], "incomingReferences": [ { "id": "string", "type": "string", "fieldId": "string", "fromObjectId": "string", "fromObjectKey": "string", "fromModuleKey": "string", "toObjectId": "string", "toObjectKey": "string", "toModuleKey": "string" } ], "outgoingReferences": [ { "id": "string", "type": "string", "fieldId": "string", "fromObjectId": "string", "fromObjectKey": "string", "fromModuleKey": "string", "toObjectId": "string", "toObjectKey": "string", "toModuleKey": "string" } ] } }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}