v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Company Details

Retrieves details of a company by company ID or external ID.

get/companies

Query parameters

externalIdstring

External ID of the company.

idinteger

Unique ID of the company.

Response

200

externalIdstring
companyIdinteger
namestring
hierarchyDefinitionCodestring
isActiveboolean

Example response

{
  "externalId": "Purple2345",
  "companyId": 98,
  "name": "Purple Distributors",
  "hierarchyDefinitionCode": "code-association2",
  "isActive": true,
  "extendedFields": {
    "address1": "Temple Street, X Road",
    "company_city": "Bangalore",
    "company_country": "India",
    "company_state": "Karnataka",
    "owner": "Capillary",
    "phone": "919900000000",
    "pincode": "560068"
  }
}