{
  "info": {
    "name": "Accurants OpenAPI",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "description": "Import this Postman v2.1 collection, then set baseUrl, apiKey and companyId in collection variables (or a private environment). The API key is intentionally blank; keep it local or use Postman Vault and never share/export a populated secret. Set customerId and leadId from your own API responses. For creation, set a unique customerCreateIdempotencyKey or leadCreateIdempotencyKey for each new logical request and reuse it with the identical body when retrying. POST/PATCH requests write real CRM data. All keys share the integration request budget; honor Retry-After on 429. Never run the entire collection unintentionally against live data."
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://uat-openapi.accurants.com",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "",
      "type": "string"
    },
    {
      "key": "companyId",
      "value": "",
      "type": "string"
    },
    {
      "key": "customerId",
      "value": "",
      "type": "string"
    },
    {
      "key": "leadId",
      "value": "",
      "type": "string"
    },
    {
      "key": "customerCreateIdempotencyKey",
      "value": "",
      "type": "string"
    },
    {
      "key": "leadCreateIdempotencyKey",
      "value": "",
      "type": "string"
    },
    {
      "key": "visitCreateIdempotencyKey",
      "value": "",
      "type": "string"
    },
    {
      "key": "page",
      "value": "1",
      "type": "string"
    },
    {
      "key": "pageSize",
      "value": "50",
      "type": "string"
    },
    {
      "key": "search",
      "value": "",
      "type": "string"
    },
    {
      "key": "email",
      "value": "",
      "type": "string"
    },
    {
      "key": "stateId",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Companies",
      "item": [
        {
          "name": "List companies",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies"
              ],
              "query": []
            },
            "description": "Returns the single active company assigned to this integration when it has an approved permission. An integration never includes parent, child or sibling companies.\n\nRequired scope: Any company grant\n\nEach company uses its own integration and API keys, regardless of ParentId."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies"
                  ],
                  "query": []
                },
                "description": "Returns the single active company assigned to this integration when it has an approved permission. An integration never includes parent, child or sibling companies.\n\nRequired scope: Any company grant\n\nEach company uses its own integration and API keys, regardless of ParentId."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\r\n  {\r\n    \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n    \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n    \u0022parentId\u0022: null\r\n  }\r\n]"
            }
          ]
        }
      ]
    },
    {
      "name": "Customers",
      "item": [
        {
          "name": "List customers",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "customers"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                }
              ]
            },
            "description": "Returns a page of active, nondeleted customers for a company. Results use stable internal CRM ordering; returned customerId values are UniqueID strings.\n\nRequired scope: customers.read\n\n"
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "customers"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    }
                  ]
                },
                "description": "Returns a page of active, nondeleted customers for a company. Results use stable internal CRM ordering; returned customerId values are UniqueID strings.\n\nRequired scope: customers.read\n\n"
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022customerId\u0022: \u002200000000-0000-0000-0000-000000001001-12345678\u0022,\r\n      \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n      \u0022displayName\u0022: \u0022Acme Industries\u0022,\r\n      \u0022firstName\u0022: \u0022Alice\u0022,\r\n      \u0022lastName\u0022: \u0022Morgan\u0022,\r\n      \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n      \u0022email\u0022: \u0022alice@example.com\u0022,\r\n      \u0022secondaryEmail\u0022: null,\r\n      \u0022phone\u0022: \u0022\\u002B15551234567\u0022,\r\n      \u0022otherPhone\u0022: null,\r\n      \u0022mobile\u0022: \u0022\\u002B15559876543\u0022,\r\n      \u0022fax\u0022: null,\r\n      \u0022website\u0022: \u0022https://example.com\u0022,\r\n      \u0022street\u0022: \u0022100 Market Street\u0022,\r\n      \u0022city\u0022: \u0022Austin\u0022,\r\n      \u0022state\u0022: \u0022TX\u0022,\r\n      \u0022zipCode\u0022: \u002278701\u0022,\r\n      \u0022countryId\u0022: 244\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        },
        {
          "name": "Retrieve a customer",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers/{{customerId}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "customers",
                "{{customerId}}"
              ],
              "query": []
            },
            "description": "Retrieves one customer\u0027s basic profile and primary billing address. The customer must belong to the company specified in the URL.\n\nRequired scope: customers.read\n\nA record belonging to another company returns 404, even when you know its customer ID."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers/{{customerId}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "customers",
                    "{{customerId}}"
                  ],
                  "query": []
                },
                "description": "Retrieves one customer\u0027s basic profile and primary billing address. The customer must belong to the company specified in the URL.\n\nRequired scope: customers.read\n\nA record belonging to another company returns 404, even when you know its customer ID."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022customerId\u0022: \u002200000000-0000-0000-0000-000000001001-12345678\u0022,\r\n  \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022displayName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022firstName\u0022: \u0022Alice\u0022,\r\n  \u0022lastName\u0022: \u0022Morgan\u0022,\r\n  \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022email\u0022: \u0022alice@example.com\u0022,\r\n  \u0022secondaryEmail\u0022: null,\r\n  \u0022phone\u0022: \u0022\\u002B15551234567\u0022,\r\n  \u0022otherPhone\u0022: null,\r\n  \u0022mobile\u0022: \u0022\\u002B15559876543\u0022,\r\n  \u0022fax\u0022: null,\r\n  \u0022website\u0022: \u0022https://example.com\u0022,\r\n  \u0022street\u0022: \u0022100 Market Street\u0022,\r\n  \u0022city\u0022: \u0022Austin\u0022,\r\n  \u0022state\u0022: \u0022TX\u0022,\r\n  \u0022zipCode\u0022: \u002278701\u0022,\r\n  \u0022countryId\u0022: 244\r\n}"
            }
          ]
        },
        {
          "name": "Create a customer",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{customerCreateIdempotencyKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "customers"
              ],
              "query": []
            },
            "description": "Creates a customer using Accurants\u0027 CRM business workflow. The linked accounting customer is created in the same transaction.\n\nRequired scope: customers.write\n\nRetry a timed-out creation using the same Idempotency-Key and body.",
            "body": {
              "mode": "raw",
              "raw": "{\r\n  \u0022displayName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022firstName\u0022: \u0022Alice\u0022,\r\n  \u0022lastName\u0022: \u0022Morgan\u0022,\r\n  \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022email\u0022: \u0022alice@example.com\u0022\r\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "key": "Idempotency-Key",
                    "value": "{{customerCreateIdempotencyKey}}"
                  },
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "customers"
                  ],
                  "query": []
                },
                "description": "Creates a customer using Accurants\u0027 CRM business workflow. The linked accounting customer is created in the same transaction.\n\nRequired scope: customers.write\n\nRetry a timed-out creation using the same Idempotency-Key and body.",
                "body": {
                  "mode": "raw",
                  "raw": "{\r\n  \u0022displayName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022firstName\u0022: \u0022Alice\u0022,\r\n  \u0022lastName\u0022: \u0022Morgan\u0022,\r\n  \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022email\u0022: \u0022alice@example.com\u0022\r\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022customerId\u0022: \u002200000000-0000-0000-0000-000000001001-12345678\u0022,\r\n  \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022displayName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022firstName\u0022: \u0022Alice\u0022,\r\n  \u0022lastName\u0022: \u0022Morgan\u0022,\r\n  \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022email\u0022: \u0022alice@example.com\u0022,\r\n  \u0022secondaryEmail\u0022: null,\r\n  \u0022phone\u0022: \u0022\\u002B15551234567\u0022,\r\n  \u0022otherPhone\u0022: null,\r\n  \u0022mobile\u0022: \u0022\\u002B15559876543\u0022,\r\n  \u0022fax\u0022: null,\r\n  \u0022website\u0022: \u0022https://example.com\u0022,\r\n  \u0022street\u0022: \u0022100 Market Street\u0022,\r\n  \u0022city\u0022: \u0022Austin\u0022,\r\n  \u0022state\u0022: \u0022TX\u0022,\r\n  \u0022zipCode\u0022: \u002278701\u0022,\r\n  \u0022countryId\u0022: 244\r\n}"
            }
          ]
        },
        {
          "name": "Update a customer",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers/{{customerId}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "customers",
                "{{customerId}}"
              ],
              "query": []
            },
            "description": "Updates the supplied basic profile fields. Omitted fields retain their current values. Pricing, accounting attributes, linked contacts, and other relationships are preserved.\n\nRequired scope: customers.write\n\nUse null to clear optional text. The display name cannot be cleared. A primaryAddress object replaces the whole default billing address.",
            "body": {
              "mode": "raw",
              "raw": "{\r\n  \u0022mobile\u0022: \u0022\\u002B15559876543\u0022\r\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "PATCH",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/customers/{{customerId}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "customers",
                    "{{customerId}}"
                  ],
                  "query": []
                },
                "description": "Updates the supplied basic profile fields. Omitted fields retain their current values. Pricing, accounting attributes, linked contacts, and other relationships are preserved.\n\nRequired scope: customers.write\n\nUse null to clear optional text. The display name cannot be cleared. A primaryAddress object replaces the whole default billing address.",
                "body": {
                  "mode": "raw",
                  "raw": "{\r\n  \u0022mobile\u0022: \u0022\\u002B15559876543\u0022\r\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022customerId\u0022: \u002200000000-0000-0000-0000-000000001001-12345678\u0022,\r\n  \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022displayName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022firstName\u0022: \u0022Alice\u0022,\r\n  \u0022lastName\u0022: \u0022Morgan\u0022,\r\n  \u0022companyName\u0022: \u0022Acme Industries\u0022,\r\n  \u0022email\u0022: \u0022alice@example.com\u0022,\r\n  \u0022secondaryEmail\u0022: null,\r\n  \u0022phone\u0022: \u0022\\u002B15551234567\u0022,\r\n  \u0022otherPhone\u0022: null,\r\n  \u0022mobile\u0022: \u0022\\u002B15559876543\u0022,\r\n  \u0022fax\u0022: null,\r\n  \u0022website\u0022: \u0022https://example.com\u0022,\r\n  \u0022street\u0022: \u0022100 Market Street\u0022,\r\n  \u0022city\u0022: \u0022Austin\u0022,\r\n  \u0022state\u0022: \u0022TX\u0022,\r\n  \u0022zipCode\u0022: \u002278701\u0022,\r\n  \u0022countryId\u0022: 244\r\n}"
            }
          ]
        }
      ]
    },
    {
      "name": "Leads",
      "item": [
        {
          "name": "List leads",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "email",
                  "value": "{{email}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns a paginated list of active leads belonging to the authorized company. Converted customers, prospects and deleted records are excluded. Default page size is 50; maximum 200. Optional email filter performs a case-insensitive exact match after trimming surrounding spaces; no wildcard or substring matching.\n\nRequired scope: leads.read\n\nFor repeat visitors, look up email before creating. No matches: create; one match: retain leadId and skip repeat creation; multiple matches: review rather than selecting the first. Only active leads are searched; existing contacts/customers are excluded. Same-name/different-email creates can still conflict with CRM display-name uniqueness. Lookup and create are not an atomic upsert."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "email",
                      "value": "{{email}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns a paginated list of active leads belonging to the authorized company. Converted customers, prospects and deleted records are excluded. Default page size is 50; maximum 200. Optional email filter performs a case-insensitive exact match after trimming surrounding spaces; no wildcard or substring matching.\n\nRequired scope: leads.read\n\nFor repeat visitors, look up email before creating. No matches: create; one match: retain leadId and skip repeat creation; multiple matches: review rather than selecting the first. Only active leads are searched; existing contacts/customers are excluded. Same-name/different-email creates can still conflict with CRM display-name uniqueness. Lookup and create are not an atomic upsert."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n      \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n      \u0022displayName\u0022: \u0022Joe Somebody\u0022,\r\n      \u0022leadType\u0022: \u0022person\u0022,\r\n      \u0022firstName\u0022: \u0022Joe\u0022,\r\n      \u0022lastName\u0022: \u0022Somebody\u0022,\r\n      \u0022companyName\u0022: \u0022Some Company\u0022,\r\n      \u0022email\u0022: \u0022joe@example.com\u0022,\r\n      \u0022phone\u0022: null,\r\n      \u0022mobile\u0022: null,\r\n      \u0022fax\u0022: null,\r\n      \u0022title\u0022: null,\r\n      \u0022website\u0022: null,\r\n      \u0022description\u0022: null,\r\n      \u0022leadOwnerId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n      \u0022leadSourceId\u0022: null,\r\n      \u0022leadStatusId\u0022: null\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        },
        {
          "name": "Retrieve a lead",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads",
                "{{leadId}}"
              ],
              "query": []
            },
            "description": "Retrieves one active lead belonging to the authorized company. Foreign, deleted or converted records return 404.\n\nRequired scope: leads.read\n\n"
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads",
                    "{{leadId}}"
                  ],
                  "query": []
                },
                "description": "Retrieves one active lead belonging to the authorized company. Foreign, deleted or converted records return 404.\n\nRequired scope: leads.read\n\n"
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n  \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022displayName\u0022: \u0022Joe Somebody\u0022,\r\n  \u0022leadType\u0022: \u0022person\u0022,\r\n  \u0022firstName\u0022: \u0022Joe\u0022,\r\n  \u0022lastName\u0022: \u0022Somebody\u0022,\r\n  \u0022companyName\u0022: \u0022Some Company\u0022,\r\n  \u0022email\u0022: \u0022joe@example.com\u0022,\r\n  \u0022phone\u0022: null,\r\n  \u0022mobile\u0022: null,\r\n  \u0022fax\u0022: null,\r\n  \u0022title\u0022: null,\r\n  \u0022website\u0022: null,\r\n  \u0022description\u0022: null,\r\n  \u0022leadOwnerId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022leadSourceId\u0022: null,\r\n  \u0022leadStatusId\u0022: null\r\n}"
            }
          ]
        },
        {
          "name": "Create a lead",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{leadCreateIdempotencyKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads"
              ],
              "query": []
            },
            "description": "Creates a person or business lead in the authorized company. Requires leads.write and an Idempotency-Key. No website connection or activation is needed.\n\nRequired scope: leads.write\n\nIdentical normalized creation retries replay the original 201 response for 24 hours. Changed payloads with the same key return 409. Display name is derived from person names or business companyName; duplicates return 409. Get leadSourceId, leadStatusId and leadOwnerId from List lead sources, List lead statuses and List lead owners for the same company.  Integration business details belong in optional enrichment, not description. Score is enrichment.score with value and optional maximum; there is no top-level score field. Omitted enrichment fields are preserved and null clears an optional field. Enrichment does not overwrite CRM fields. Read it using Retrieve lead enrichment. When leadStatusId is omitted, the lead starts in New Lead. Get its public UniqueID from List lead statuses; numeric status IDs are not accepted. An explicit null leaves the status unset.",
            "body": {
              "mode": "raw",
              "raw": "{\r\n  \u0022firstName\u0022: \u0022Joe\u0022,\r\n  \u0022lastName\u0022: \u0022Somebody\u0022,\r\n  \u0022companyName\u0022: \u0022Some Company\u0022,\r\n  \u0022email\u0022: \u0022joe@example.com\u0022,\r\n  \u0022enrichment\u0022: {\r\n    \u0022companyDomain\u0022: \u0022example.com\u0022,\r\n    \u0022employeeCount\u0022: 57,\r\n    \u0022industry\u0022: \u0022Software\u0022,\r\n    \u0022score\u0022: {\r\n      \u0022value\u0022: 85,\r\n      \u0022maximum\u0022: 100\r\n    }\r\n  }\r\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "key": "Idempotency-Key",
                    "value": "{{leadCreateIdempotencyKey}}"
                  },
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads"
                  ],
                  "query": []
                },
                "description": "Creates a person or business lead in the authorized company. Requires leads.write and an Idempotency-Key. No website connection or activation is needed.\n\nRequired scope: leads.write\n\nIdentical normalized creation retries replay the original 201 response for 24 hours. Changed payloads with the same key return 409. Display name is derived from person names or business companyName; duplicates return 409. Get leadSourceId, leadStatusId and leadOwnerId from List lead sources, List lead statuses and List lead owners for the same company.  Integration business details belong in optional enrichment, not description. Score is enrichment.score with value and optional maximum; there is no top-level score field. Omitted enrichment fields are preserved and null clears an optional field. Enrichment does not overwrite CRM fields. Read it using Retrieve lead enrichment. When leadStatusId is omitted, the lead starts in New Lead. Get its public UniqueID from List lead statuses; numeric status IDs are not accepted. An explicit null leaves the status unset.",
                "body": {
                  "mode": "raw",
                  "raw": "{\r\n  \u0022firstName\u0022: \u0022Joe\u0022,\r\n  \u0022lastName\u0022: \u0022Somebody\u0022,\r\n  \u0022companyName\u0022: \u0022Some Company\u0022,\r\n  \u0022email\u0022: \u0022joe@example.com\u0022,\r\n  \u0022enrichment\u0022: {\r\n    \u0022companyDomain\u0022: \u0022example.com\u0022,\r\n    \u0022employeeCount\u0022: 57,\r\n    \u0022industry\u0022: \u0022Software\u0022,\r\n    \u0022score\u0022: {\r\n      \u0022value\u0022: 85,\r\n      \u0022maximum\u0022: 100\r\n    }\r\n  }\r\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n  \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022displayName\u0022: \u0022Joe Somebody\u0022,\r\n  \u0022leadType\u0022: \u0022person\u0022,\r\n  \u0022firstName\u0022: \u0022Joe\u0022,\r\n  \u0022lastName\u0022: \u0022Somebody\u0022,\r\n  \u0022companyName\u0022: \u0022Some Company\u0022,\r\n  \u0022email\u0022: \u0022joe@example.com\u0022,\r\n  \u0022phone\u0022: null,\r\n  \u0022mobile\u0022: null,\r\n  \u0022fax\u0022: null,\r\n  \u0022title\u0022: null,\r\n  \u0022website\u0022: null,\r\n  \u0022description\u0022: null,\r\n  \u0022leadOwnerId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022leadSourceId\u0022: null,\r\n  \u0022leadStatusId\u0022: null\r\n}"
            }
          ]
        },
        {
          "name": "Update a lead",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads",
                "{{leadId}}"
              ],
              "query": []
            },
            "description": "Updates an existing lead in the authorized company. Send only the fields to change; omitted fields are preserved. Requires leads.write.\n\nRequired scope: leads.write\n\n Get leadSourceId, leadStatusId and leadOwnerId from List lead sources, List lead statuses and List lead owners for the same company.  Integration business details belong in optional enrichment, not description. Score is enrichment.score with value and optional maximum; there is no top-level score field. Omitted enrichment fields are preserved and null clears an optional field. Enrichment does not overwrite CRM fields. Read it using Retrieve lead enrichment. Omitted leadStatusId preserves the existing status; null clears it.",
            "body": {
              "mode": "raw",
              "raw": "{\r\n  \u0022phone\u0022: \u0022\\u002B15551234567\u0022,\r\n  \u0022enrichment\u0022: {\r\n    \u0022companyDomain\u0022: \u0022example.com\u0022,\r\n    \u0022employeeCount\u0022: 57,\r\n    \u0022industry\u0022: \u0022Software\u0022,\r\n    \u0022score\u0022: {\r\n      \u0022value\u0022: 85,\r\n      \u0022maximum\u0022: 100\r\n    }\r\n  }\r\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "PATCH",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads",
                    "{{leadId}}"
                  ],
                  "query": []
                },
                "description": "Updates an existing lead in the authorized company. Send only the fields to change; omitted fields are preserved. Requires leads.write.\n\nRequired scope: leads.write\n\n Get leadSourceId, leadStatusId and leadOwnerId from List lead sources, List lead statuses and List lead owners for the same company.  Integration business details belong in optional enrichment, not description. Score is enrichment.score with value and optional maximum; there is no top-level score field. Omitted enrichment fields are preserved and null clears an optional field. Enrichment does not overwrite CRM fields. Read it using Retrieve lead enrichment. Omitted leadStatusId preserves the existing status; null clears it.",
                "body": {
                  "mode": "raw",
                  "raw": "{\r\n  \u0022phone\u0022: \u0022\\u002B15551234567\u0022,\r\n  \u0022enrichment\u0022: {\r\n    \u0022companyDomain\u0022: \u0022example.com\u0022,\r\n    \u0022employeeCount\u0022: 57,\r\n    \u0022industry\u0022: \u0022Software\u0022,\r\n    \u0022score\u0022: {\r\n      \u0022value\u0022: 85,\r\n      \u0022maximum\u0022: 100\r\n    }\r\n  }\r\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n  \u0022companyId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022displayName\u0022: \u0022Joe Somebody\u0022,\r\n  \u0022leadType\u0022: \u0022person\u0022,\r\n  \u0022firstName\u0022: \u0022Joe\u0022,\r\n  \u0022lastName\u0022: \u0022Somebody\u0022,\r\n  \u0022companyName\u0022: \u0022Some Company\u0022,\r\n  \u0022email\u0022: \u0022joe@example.com\u0022,\r\n  \u0022phone\u0022: null,\r\n  \u0022mobile\u0022: null,\r\n  \u0022fax\u0022: null,\r\n  \u0022title\u0022: null,\r\n  \u0022website\u0022: null,\r\n  \u0022description\u0022: null,\r\n  \u0022leadOwnerId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n  \u0022leadSourceId\u0022: null,\r\n  \u0022leadStatusId\u0022: null\r\n}"
            }
          ]
        }
      ]
    },
    {
      "name": "Reference data",
      "item": [
        {
          "name": "List countries",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/masters/countries?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "masters",
                "countries"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "search",
                  "value": "{{search}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns a page from the shared countries master catalog. Identifiers are UniqueID strings.\n\nRequired scope: Valid API key\n\nRead only. No create, edit or delete operations are available."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/masters/countries?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "masters",
                    "countries"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "search",
                      "value": "{{search}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns a page from the shared countries master catalog. Identifiers are UniqueID strings.\n\nRequired scope: Valid API key\n\nRead only. No create, edit or delete operations are available."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022countryId\u0022: \u002200000000-0000-0000-0000-000000000001-12345678\u0022,\r\n      \u0022name\u0022: \u0022United States\u0022,\r\n      \u0022code\u0022: \u0022US\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        },
        {
          "name": "List states",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/masters/states?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "masters",
                "states"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "search",
                  "value": "{{search}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns a page from the shared states master catalog. Identifiers are UniqueID strings.\n\nRequired scope: Valid API key\n\nRead only. No create, edit or delete operations are available. This is the existing Accurants state catalog; the data does not define country relationships or guarantee worldwide coverage."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/masters/states?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "masters",
                    "states"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "search",
                      "value": "{{search}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns a page from the shared states master catalog. Identifiers are UniqueID strings.\n\nRequired scope: Valid API key\n\nRead only. No create, edit or delete operations are available. This is the existing Accurants state catalog; the data does not define country relationships or guarantee worldwide coverage."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022stateId\u0022: \u002200000000-0000-0000-0000-000000000002-12345678\u0022,\r\n      \u0022name\u0022: \u0022Texas\u0022,\r\n      \u0022code\u0022: \u0022TX\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        },
        {
          "name": "List cities",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/masters/cities?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "masters",
                "cities"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "search",
                  "value": "{{search}}",
                  "disabled": true
                },
                {
                  "key": "stateId",
                  "value": "{{stateId}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns a page from the shared cities master catalog. Identifiers are UniqueID strings.\n\nRequired scope: Valid API key\n\nRead only. No create, edit or delete operations are available. Lists active shared city catalog entries, not company-city mappings. stateId is null where stored state text has no unambiguous match."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/masters/cities?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "masters",
                    "cities"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "search",
                      "value": "{{search}}",
                      "disabled": true
                    },
                    {
                      "key": "stateId",
                      "value": "{{stateId}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns a page from the shared cities master catalog. Identifiers are UniqueID strings.\n\nRequired scope: Valid API key\n\nRead only. No create, edit or delete operations are available. Lists active shared city catalog entries, not company-city mappings. stateId is null where stored state text has no unambiguous match."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022cityId\u0022: \u002200000000-0000-0000-0000-000000000003-12345678\u0022,\r\n      \u0022name\u0022: \u0022Austin\u0022,\r\n      \u0022stateId\u0022: \u002200000000-0000-0000-0000-000000000002-12345678\u0022,\r\n      \u0022stateName\u0022: \u0022TX\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        }
      ]
    },
    {
      "name": "Lead reference data",
      "item": [
        {
          "name": "List lead sources",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/masters/lead-sources?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "masters",
                "lead-sources"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "search",
                  "value": "{{search}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns active lead sources available to the authorized company. Read only; use returned identifiers in lead creation and updates.\n\nRequired scope: leads.read\n\nIdentifiers are public strings. No create, edit or delete operation is available. Inactive and deleted values are excluded."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/masters/lead-sources?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "masters",
                    "lead-sources"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "search",
                      "value": "{{search}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns active lead sources available to the authorized company. Read only; use returned identifiers in lead creation and updates.\n\nRequired scope: leads.read\n\nIdentifiers are public strings. No create, edit or delete operation is available. Inactive and deleted values are excluded."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022leadSourceId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n      \u0022name\u0022: \u0022Website referral\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        },
        {
          "name": "List lead statuses",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/masters/lead-statuses?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "masters",
                "lead-statuses"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "search",
                  "value": "{{search}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns active company-defined and shared system lead statuses, including New Lead. Read only; use returned UniqueID strings in lead requests.\n\nRequired scope: leads.read\n\nIdentifiers are public strings. No create, edit or delete operation is available. Inactive and deleted values are excluded. Shared system statuses are available to every authorized company; another company\u0027s custom statuses are excluded."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/masters/lead-statuses?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "masters",
                    "lead-statuses"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "search",
                      "value": "{{search}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns active company-defined and shared system lead statuses, including New Lead. Read only; use returned UniqueID strings in lead requests.\n\nRequired scope: leads.read\n\nIdentifiers are public strings. No create, edit or delete operation is available. Inactive and deleted values are excluded. Shared system statuses are available to every authorized company; another company\u0027s custom statuses are excluded."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022leadStatusId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n      \u0022name\u0022: \u0022New\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        },
        {
          "name": "List lead owners",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/masters/lead-owners?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "masters",
                "lead-owners"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                },
                {
                  "key": "search",
                  "value": "{{search}}",
                  "disabled": true
                }
              ]
            },
            "description": "Returns active lead owners available to the authorized company. Read only; use returned identifiers in lead creation and updates.\n\nRequired scope: leads.read\n\nIdentifiers are public strings. No create, edit or delete operation is available. System accounts and inactive users are excluded."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/masters/lead-owners?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "masters",
                    "lead-owners"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    },
                    {
                      "key": "search",
                      "value": "{{search}}",
                      "disabled": true
                    }
                  ]
                },
                "description": "Returns active lead owners available to the authorized company. Read only; use returned identifiers in lead creation and updates.\n\nRequired scope: leads.read\n\nIdentifiers are public strings. No create, edit or delete operation is available. System accounts and inactive users are excluded."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022leadOwnerId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n      \u0022name\u0022: \u0022Company owner\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        }
      ]
    },
    {
      "name": "Lead insights",
      "item": [
        {
          "name": "Retrieve lead enrichment",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}/enrichment",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads",
                "{{leadId}}",
                "enrichment"
              ],
              "query": []
            },
            "description": "Returns only your integration\u0027s enrichment for this company record. An absent enrichment object is null.\n\nRequired scope: leads.read\n\nOnly the authenticated integration\u0027s information is returned. Existing CRM descriptions and notes remain separate."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}/enrichment",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads",
                    "{{leadId}}",
                    "enrichment"
                  ],
                  "query": []
                },
                "description": "Returns only your integration\u0027s enrichment for this company record. An absent enrichment object is null.\n\nRequired scope: leads.read\n\nOnly the authenticated integration\u0027s information is returned. Existing CRM descriptions and notes remain separate."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n  \u0022enrichment\u0022: {\r\n    \u0022industry\u0022: \u0022Software\u0022,\r\n    \u0022employeeCount\u0022: 57,\r\n    \u0022score\u0022: {\r\n      \u0022value\u0022: 85,\r\n      \u0022maximum\u0022: 100\r\n    }\r\n  },\r\n  \u0022modifiedAt\u0022: \u00222026-10-24T10:00:00Z\u0022\r\n}"
            }
          ]
        },
        {
          "name": "Record a lead visit",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{visitCreateIdempotencyKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}/visits",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads",
                "{{leadId}}",
                "visits"
              ],
              "query": []
            },
            "description": "Appends a visit without changing CRM fields or notes. Requires sessionId, occurredAt and Idempotency-Key.\n\nRequired scope: leads.write\n\n201 is returned after commit. Same session and identical normalized content replays even after 24 hours; changed session content returns visit_session_conflict (409). A changed request using the same retry key within 24 hours returns idempotency_conflict (409). Reuse the original key/body on network or 503 errors and honor Retry-After on 429.",
            "body": {
              "mode": "raw",
              "raw": "{\r\n  \u0022sessionId\u0022: \u0022session-example-1\u0022,\r\n  \u0022occurredAt\u0022: \u00222026-10-24T10:00:00Z\u0022,\r\n  \u0022referrer\u0022: \u0022https://example.com/\u0022,\r\n  \u0022firstVisit\u0022: true,\r\n  \u0022campaignName\u0022: \u0022October newsletter\u0022,\r\n  \u0022campaignSource\u0022: \u0022newsletter\u0022,\r\n  \u0022campaignMedium\u0022: \u0022email\u0022,\r\n  \u0022score\u0022: {\r\n    \u0022value\u0022: 85,\r\n    \u0022maximum\u0022: 100\r\n  },\r\n  \u0022pages\u0022: [\r\n    {\r\n      \u0022url\u0022: \u0022https://example.com/services\u0022,\r\n      \u0022visitedAt\u0022: \u00222026-10-24T10:00:00Z\u0022,\r\n      \u0022seconds\u0022: 63\r\n    }\r\n  ]\r\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "key": "Idempotency-Key",
                    "value": "{{visitCreateIdempotencyKey}}"
                  },
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}/visits",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads",
                    "{{leadId}}",
                    "visits"
                  ],
                  "query": []
                },
                "description": "Appends a visit without changing CRM fields or notes. Requires sessionId, occurredAt and Idempotency-Key.\n\nRequired scope: leads.write\n\n201 is returned after commit. Same session and identical normalized content replays even after 24 hours; changed session content returns visit_session_conflict (409). A changed request using the same retry key within 24 hours returns idempotency_conflict (409). Reuse the original key/body on network or 503 errors and honor Retry-After on 429.",
                "body": {
                  "mode": "raw",
                  "raw": "{\r\n  \u0022sessionId\u0022: \u0022session-example-1\u0022,\r\n  \u0022occurredAt\u0022: \u00222026-10-24T10:00:00Z\u0022,\r\n  \u0022referrer\u0022: \u0022https://example.com/\u0022,\r\n  \u0022firstVisit\u0022: true,\r\n  \u0022campaignName\u0022: \u0022October newsletter\u0022,\r\n  \u0022campaignSource\u0022: \u0022newsletter\u0022,\r\n  \u0022campaignMedium\u0022: \u0022email\u0022,\r\n  \u0022score\u0022: {\r\n    \u0022value\u0022: 85,\r\n    \u0022maximum\u0022: 100\r\n  },\r\n  \u0022pages\u0022: [\r\n    {\r\n      \u0022url\u0022: \u0022https://example.com/services\u0022,\r\n      \u0022visitedAt\u0022: \u00222026-10-24T10:00:00Z\u0022,\r\n      \u0022seconds\u0022: 63\r\n    }\r\n  ]\r\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022visitId\u0022: \u002200000000-0000-0000-0000-000000005678-12345678\u0022,\r\n  \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022,\r\n  \u0022sessionId\u0022: \u0022session-example-1\u0022,\r\n  \u0022occurredAt\u0022: \u00222026-10-24T10:00:00Z\u0022\r\n}"
            }
          ]
        },
        {
          "name": "List lead visits",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}/visits?page={{page}}\u0026pageSize={{pageSize}}",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "v1",
                "companies",
                "{{companyId}}",
                "leads",
                "{{leadId}}",
                "visits"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "{{page}}"
                },
                {
                  "key": "pageSize",
                  "value": "{{pageSize}}"
                }
              ]
            },
            "description": "Returns your integration\u0027s visit history in descending occurrence time and visit ID order.\n\nRequired scope: leads.read\n\nOnly the authenticated integration\u0027s information is returned. Existing CRM descriptions and notes remain separate."
          },
          "response": [
            {
              "name": "Example response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api/v1/companies/{{companyId}}/leads/{{leadId}}/visits?page={{page}}\u0026pageSize={{pageSize}}",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api",
                    "v1",
                    "companies",
                    "{{companyId}}",
                    "leads",
                    "{{leadId}}",
                    "visits"
                  ],
                  "query": [
                    {
                      "key": "page",
                      "value": "{{page}}"
                    },
                    {
                      "key": "pageSize",
                      "value": "{{pageSize}}"
                    }
                  ]
                },
                "description": "Returns your integration\u0027s visit history in descending occurrence time and visit ID order.\n\nRequired scope: leads.read\n\nOnly the authenticated integration\u0027s information is returned. Existing CRM descriptions and notes remain separate."
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\r\n  \u0022items\u0022: [\r\n    {\r\n      \u0022sessionId\u0022: \u0022session-example-1\u0022,\r\n      \u0022occurredAt\u0022: \u00222026-10-24T10:00:00Z\u0022,\r\n      \u0022referrer\u0022: \u0022https://example.com/\u0022,\r\n      \u0022firstVisit\u0022: true,\r\n      \u0022campaignName\u0022: \u0022October newsletter\u0022,\r\n      \u0022campaignSource\u0022: \u0022newsletter\u0022,\r\n      \u0022campaignMedium\u0022: \u0022email\u0022,\r\n      \u0022score\u0022: {\r\n        \u0022value\u0022: 85,\r\n        \u0022maximum\u0022: 100\r\n      },\r\n      \u0022pages\u0022: [\r\n        {\r\n          \u0022url\u0022: \u0022https://example.com/services\u0022,\r\n          \u0022visitedAt\u0022: \u00222026-10-24T10:00:00Z\u0022,\r\n          \u0022seconds\u0022: 63\r\n        }\r\n      ],\r\n      \u0022visitId\u0022: \u002200000000-0000-0000-0000-000000005678-12345678\u0022,\r\n      \u0022leadId\u0022: \u002200000000-0000-0000-0000-000000001234-12345678\u0022\r\n    }\r\n  ],\r\n  \u0022pageNumber\u0022: 1,\r\n  \u0022pageSize\u0022: 50\r\n}"
            }
          ]
        }
      ]
    }
  ]
}