v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB

Custom Object Schemas

Get custom object schema

get/crm/custom-object-schemas/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Response

Custom object schema

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "custom-object-schemas",
  "operation": "one",
  "data": {
    "id": "cos_12345",
    "name": "project",
    "description": "This schema defines a project custom object",
    "fields": [
      {
        "id": "field_123",
        "name": "project_name",
        "description": "Name of the project",
        "type": "string",
        "required": true,
        "options": [
          {
            "value": "option1",
            "label": "Option 1"
          }
        ],
        "default_value": "New Project"
      }
    ],
    "visible": true,
    "active": true,
    "created_by": "12345",
    "updated_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "pass_through": [
      {
        "extend_paths": [
          {
            "path": "$.nested.property",
            "value": {
              "TaxClassificationRef": {
                "value": "EUC-99990201-V1-00020000"
              }
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  }
}