DIdistru
Company

Get a company

Changed on

Fetch one company from your CRM by its ID, including its underlying business record, owner, group, relationship type, payment term, custom fields, licenses, locations, and computed outstanding balance.

Returns 404 if no company with that ID exists on your account, and 403 if your team restrictions hide it. A soft-deleted company is still returned here, with a non-null deleted_at. This read is served from a replica and is eventually consistent — a create or update made through the API can take up to 1 second to be reflected.

Required permission: companies_permissions_view.

get/public/v1/companies/{id}

Request

  • Base URL
    https://app.distru.com
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the company to fetch.

Response

A single company

Example response

{
  "data": {
    "default_payment_term": {
      "name": "Net 30",
      "time_of_day": "17:00:00"
    },
    "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
    "licenses": [
      {
        "id": "02c88a3f-d759-4973-88f9-60049d682524",
        "license_number": "C11-1234567890"
      }
    ],
    "locations": [
      {
        "address": "1234 Warehouse Street, Oakland, CA",
        "company_id": "02c88a3f-d759-4973-88f9-60049d682524",
        "id": "02c88a3f-d759-4973-88f9-60049d682524",
        "license_id": "02c88a3f-d759-4973-88f9-60049d682524",
        "name": "Warehouse 1"
      }
    ],
    "name": "Retailer 1"
  }
}

Changes

  • e8b3a3d07ad5Revision changes
    • info

      the response property / became required for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property / to the response with the status

  • 532edce931d0Revision changes
    • warning

      added the new Retail - Affiliated enum value to the / response property for the response status

    • warning

      added the new Retail - Unaffiliated enum value to the / response property for the response status