/accounts/{id}

GET

/crm/v1/accounts/:id

GET

/api/crm/v1/accounts/:id

curl -G https://api.merge.dev/api/crm/v1/accounts/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d include_remote_data=true

200Retrieved

{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "owner": "0258cbc6-6020-430a-848e-aafacbadf4ae",
  "name": "Merge API",
  "description": "One API for all integrations",
  "industry": "API's",
  "website": "https://merge.dev/",
  "number_of_employees": 276000,
  "addresses": [
    {
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "street_1": "50 Bowling Green Dr",
      "street_2": "Golden Gate Park",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94122",
      "country": "US",
      "address_type": "BILLING"
    }
  ],
  "phone_numbers": [
    {
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "phone_number": "+16788879833",
      "phone_number_type": "Mobile"
    }
  ],
  "last_activity_at": "2022-02-10T00:00:00Z",
  "remote_updated_at": "2022-01-09T00:00:00Z",
  "remote_created_at": "2021-11-10T00:00:00Z",
  "account_url": "https://crm.example.com/accounts/19202938",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/accounts",
      "data": null
    }
  ],
  "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 an Account object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

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_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

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

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

The last date (either most recent or furthest in the future) of when an activity occurs in an account.

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.

account_urlstring or nullOptionalformat: "uri"<=2000 characters

The account's URL in the remote system.

remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only