/custom-object-classes/{id}

Returns a CustomObjectClass object with the given id.

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

idstringRequiredformat: "uuid"

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).

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

modified_atdatetime or nullRead-only

namestring or null

The custom object class's name.

descriptionstring or null

The custom object class's description.

labelsmap from strings to strings or nullRead-only

The custom object class's singular and plural labels.

fieldslist of objects or nullRead-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.

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.crm.custom_object_classes.retrieve(
8	id="id",
9	)

1	{
2	"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
3	"remote_id": "9579977",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "order",
7	"description": "Order object",
8	"labels": {
9	"singular": "Order",
10	"plural": "Orders"
11	},
12	"fields": [
13	{
14	"display_name": "Order ID",
15	"remote_key_name": "order_id",
16	"description": "The unique ID for the order.",
17	"is_required": true,
18	"field_type": "string",
19	"field_format": "string",
20	"field_choices": [],
21	"item_schema": {
22	"item_type": "string",
23	"item_format": "string",
24	"item_choices": [
25	"string"
26	]
27	},
28	"is_nested_list": false
29	},
30	{
31	"display_name": "Order Quantity",
32	"remote_key_name": "order_quantity",
33	"description": "The number of items ordered.",
34	"is_required": true,
35	"field_type": "number",
36	"field_format": "number",
37	"field_choices": [],
38	"item_schema": {
39	"item_type": "string",
40	"item_format": "string",
41	"item_choices": [
42	"string"
43	]
44	},
45	"is_nested_list": false
46	},
47	{
48	"display_name": "Customer Type",
49	"remote_key_name": "customer_type",
50	"description": "The type of customer.",
51	"is_required": true,
52	"field_type": "string",
53	"field_format": "string",
54	"field_choices": [
55	"New",
56	"Returning"
57	],
58	"is_nested_list": false
59	}
60	],
61	"association_types": [
62	{}
63	]
64	}