/custom-object-classes/{custom_object_class_id}/custom-objects/{id}

from merge import Merge
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
    custom_object_class_id="custom_object_class_id",
    id="id",
)

{
  "id": "da0b1963-be70-469c-9f8c-06a81d0fe759",
  "remote_id": "4183634295",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "object_class": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
  "fields": {
    "order_id": "4183634295",
    "order_quantity": 50,
    "customer_type": "Returning"
  },
  "remote_fields": [
    {
      "remote_field_class": {
        "id": "string",
        "display_name": "string",
        "remote_key_name": "string",
        "description": "string",
        "is_custom": true,
        "is_common_model_field": true,
        "is_required": true,
        "field_type": "string",
        "field_format": "string",
        "field_choices": [
          "string"
        ],
        "item_schema": {
          "item_type": "string",
          "item_format": "string",
          "item_choices": [
            "string"
          ]
        }
      },
      "value": "string"
    }
  ]
}

Returns a CustomObject object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

custom_object_class_idstringRequiredformat: "uuid"

idstringRequiredformat: "uuid"

Query parameters

include_remote_databooleanOptional

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

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

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

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

object_classstring or nullformat: "uuid"

The custom object class the custom object record belongs to.

fieldsmap from strings to anyRead-only

The fields and values contained within the custom object record.

remote_fieldslist of objectsRead-only

Authentication

Path parameters

Headers

Query parameters

Response