/custom-object-classes/{id}

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.crm.customObjectClasses.retrieve("id", {
    includeRemoteData: true,
    includeShellData: true
});

{
  "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
  "remote_id": "9579977",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "name": "order",
  "description": "Order object",
  "labels": {
    "singular": "Order",
    "plural": "Orders"
  },
  "fields": [
    {
      "display_name": "Order ID",
      "remote_key_name": "order_id",
      "description": "The unique ID for the order.",
      "is_required": true,
      "field_type": "string",
      "field_format": "string",
      "field_choices": [],
      "item_schema": {
        "item_type": "string",
        "item_format": "string",
        "item_choices": [
          "string"
        ]
      },
      "is_nested_list": false
    },
    {
      "display_name": "Order Quantity",
      "remote_key_name": "order_quantity",
      "description": "The number of items ordered.",
      "is_required": true,
      "field_type": "number",
      "field_format": "number",
      "field_choices": [],
      "item_schema": {
        "item_type": "string",
        "item_format": "string",
        "item_choices": [
          "string"
        ]
      },
      "is_nested_list": false
    },
    {
      "display_name": "Customer Type",
      "remote_key_name": "customer_type",
      "description": "The type of customer.",
      "is_required": true,
      "field_type": "string",
      "field_format": "string",
      "field_choices": [
        "New",
        "Returning"
      ],
      "is_nested_list": false
    }
  ],
  "association_types": [
    {}
  ]
}

Returns a CustomObjectClass object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

modified_atdatetimeRead-only

namestring or null

The custom object class's name.

descriptionstring or null

The custom object class's description.

labelsmap from strings to stringsRead-only

The custom object class's singular and plural labels.

fieldslist of objectsRead-only

association_typeslist of maps from strings to any or nullRead-only

The types of associations with other models that the custom object class can have.

Authentication

Path parameters

Headers

Query parameters

Response