For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Account object
          • GET/accounts
          • POST/accounts
          • GET/accounts/{id}
          • PATCH/accounts/{id}
          • GET/accounts/meta/patch/{id}
          • GET/accounts/meta/post
          • GET/accounts/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsAccounts

The Account object

The Account Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "owner": "string",
7  "name": "string",
8  "description": "string",
9  "industry": "string",
10  "website": "string",
11  "number_of_employees": 0,
12  "addresses": [
13    {
14      "created_at": "2023-01-01T00:00:00Z",
15      "modified_at": "2023-01-01T00:00:00Z",
16      "street_1": "string",
17      "street_2": "string",
18      "city": "string",
19      "state": "string",
20      "postal_code": "string",
21      "country": "AF",
22      "address_type": "BILLING"
23    }
24  ],
25  "phone_numbers": [
26    {
27      "created_at": "2023-01-01T00:00:00Z",
28      "modified_at": "2023-01-01T00:00:00Z",
29      "phone_number": "string",
30      "phone_number_type": "string"
31    }
32  ],
33  "last_activity_at": "2023-01-01T00:00:00Z",
34  "remote_updated_at": "2023-01-01T00:00:00Z",
35  "remote_created_at": "2023-01-01T00:00:00Z",
36  "remote_was_deleted": true,
37  "field_mappings": {},
38  "remote_data": [
39    {
40      "path": "string",
41      "data": {}
42    }
43  ],
44  "remote_fields": [
45    {
46      "remote_field_class": {
47        "id": "string",
48        "display_name": "string",
49        "remote_key_name": "string",
50        "description": "string",
51        "is_custom": true,
52        "is_common_model_field": true,
53        "is_required": true,
54        "field_type": "string",
55        "field_format": "string",
56        "field_choices": [
57          "string"
58        ],
59        "item_schema": {
60          "item_type": "string",
61          "item_format": "string",
62          "item_choices": [
63            "string"
64          ]
65        }
66      },
67      "value": {
68        "string": {}
69      }
70    }
71  ]
72}
Was this page helpful?
Previous

Versioning

Next

/accounts

Built with

The Account object is used to represent a company in a CRM system.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
ownerstring or nullOptionalformat: "uuid"
The account's owner.
namestring or nullOptional
The account's name.
descriptionstring or nullOptional
The account's description.
industrystring or nullOptional
The account's industry.
websitestring or nullOptionalformat: "uri"<=2000 characters
The account's website.
number_of_employeesinteger or nullOptional-2147483648-2147483647
The account's number of employees.
addresseslist of objectsOptional
phone_numberslist of objectsOptionalRead-only
last_activity_atdatetime or nullOptional
remote_updated_atdatetime or nullOptional
When the CRM system account data was last modified by a user with a login.
remote_created_atdatetime or nullOptional
When the third party's account was created.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only