> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. # /accounts GET https://api.merge.dev/api/crm/v1/accounts Returns a list of `Account` objects. Reference: https://docs.merge.dev/merge-unified/crm/common-models/accounts/list ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) ## Request ### Query parameters - `created_after` (datetime, optional) — If provided, will only return objects created after this datetime. - `created_before` (datetime, optional) — If provided, will only return objects created before this datetime. - `cursor` (string, optional) — The pagination cursor value. - `expand` (list of enum, optional) — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - Allowed values: `owner` - `include_deleted_data` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/). - `include_remote_data` (boolean, optional) — Whether to include the original data Merge fetched from the third-party to produce these models. - `include_remote_fields` (boolean, optional) — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - `include_shell_data` (boolean, optional) — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - `modified_after` (datetime, optional) — If provided, only objects synced by Merge after this date time will be returned. - `modified_before` (datetime, optional) — If provided, only objects synced by Merge before this date time will be returned. - `name` (string, optional) — If provided, will only return accounts with this name. - `owner_id` (string, optional) — If provided, will only return accounts with this owner. - `page_size` (integer, optional) — Number of results to return per page. The maximum limit is 100. - `remote_id` (string, optional) — The API provider's ID for the given object. ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ## Response ### 200 - `next` (string, optional, nullable) - `previous` (string, optional, nullable) - `results` (list of Account, optional) ## Types ### Account # The Account Object ### Description The `Account` object is used to represent a company in a CRM system. ### Usage Example TODO - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `owner` (string, optional, nullable) — The account's owner. - `name` (string, optional, nullable) — The account's name. - `description` (string, optional, nullable) — The account's description. - `industry` (string, optional, nullable) — The account's industry. - `website` (string, optional, nullable) — The account's website. - `number_of_employees` (integer, optional, nullable) — The account's number of employees. - `addresses` (list of Address, optional) - `phone_numbers` (list of PhoneNumber, optional) - `last_activity_at` (datetime, optional, nullable) — The last date (either most recent or furthest in the future) of when an activity occurs in an account. - `remote_updated_at` (datetime, optional, nullable) — When the CRM system account data was last modified by a user with a login. - `remote_created_at` (datetime, optional, nullable) — When the third party's account was created. - `account_url` (string, optional, nullable) — The account's URL in the remote system. - `remote_was_deleted` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/). - `field_mappings` (AccountFieldMappings, optional, nullable) - `remote_data` (list of RemoteData, optional, nullable) - `remote_fields` (list of RemoteField, optional) ### Address # The Address Object ### Description The `Address` object is used to represent an entity's address. ### Usage Example TODO - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `street_1` (string, optional, nullable) — Line 1 of the address's street. - `street_2` (string, optional, nullable) — Line 2 of the address's street. - `city` (string, optional, nullable) — The address's city. - `state` (string, optional, nullable) — The address's state. - `postal_code` (string, optional, nullable) — The address's postal code. - `country` (enum, optional, nullable) — The address's country. The country code in ISO 3166-1 alpha-2 format. - Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW` - `address_type` (enum, optional, nullable) — The address type. - Allowed values: `BILLING`, `SHIPPING` ### PhoneNumber # The PhoneNumber Object ### Description The `PhoneNumber` object is used to represent an entity's phone number. ### Usage Example Fetch from the `GET Contact` endpoint and view their phone numbers. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `phone_number` (string, optional, nullable) — The phone number. - `phone_number_type` (string, optional, nullable) — The phone number's type. ### AccountFieldMappings - `organization_defined_targets` (map from string to any, optional) - `linked_account_defined_targets` (map from string to any, optional) ### RemoteData # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO - `path` (string, required) — The third-party API path that is being called. - `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format. ### RemoteField - `remote_field_class` (RemoteFieldClass, required) - `value` (map from string to any, optional) ### RemoteFieldClass - `id` (string, optional) - `display_name` (string, optional) - `remote_key_name` (string, optional) - `description` (string, optional) - `is_custom` (boolean, optional) - `is_common_model_field` (boolean, optional) - `is_required` (boolean, optional) - `field_type` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `field_format` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `field_choices` (list of string, optional) - `item_schema` (ItemSchema, optional) ### ItemSchema - `item_type` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `item_format` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `item_choices` (list of string, optional) ## Examples **Response** ```json { "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ", "results": [ { "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" } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/crm/v1/accounts" querystring = {"include_remote_data":"true"} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true'; const options = { method: 'GET', headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/crm/v1/accounts?include_remote_data=true")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```