---
title: "Get a Company"
method: GET
path: "/v1/company/{companyId}"
tags: ["Companies"]
---

# Get a Company

`GET /v1/company/{companyId}`

## Request

- Base URL: `https://api.avionte.com/front-office`
- URL: `https://api.avionte.com/front-office/v1/company/{companyId}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns details about the specified company.

## Path parameters

- `companyId` string, required

## Headers

- `RequestId` string, uuid: Unique request identifier in UUID format used to correlate request data to log entries and events.
- `FrontOfficeTenantId` integer
- `Tenant` string

## Response `200`

The retrieved company record.

- Company
  - `id` integer: The identifier for the company.
  - `name` string: The name of the company.
  - `mainAddress` Address
    - `street1` string: Street address, line 1.
    - `street2` string: Street address, line 2.
    - `city` string: City.
    - `state_Province` string: ISO 2-character code for the Province, State, or Region.
    - `postalCode` string: ZIP/postal code.
    - `country` string: A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.
    - `county` string: County.
    - `geoCode` string: Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.
    - `schoolDistrictCode` string: School district code based on the Geo Code.
  - `billingAddress` Address
    - `street1` string: Street address, line 1.
    - `street2` string: Street address, line 2.
    - `city` string: City.
    - `state_Province` string: ISO 2-character code for the Province, State, or Region.
    - `postalCode` string: ZIP/postal code.
    - `country` string: A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.
    - `county` string: County.
    - `geoCode` string: Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.
    - `schoolDistrictCode` string: School district code based on the Geo Code.
  - `frontOfficeId` integer: The identifier for the company's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the <a href="https://developer.avionte.com/reference/getbranches">Get Branches</a> endpoint to retrieve the ID.
  - `link` string: The BOLD URL of the company.
  - `isArchived` boolean: An indication of whether the company record is archived or not.
  - `representativeUsers` integer[]: The IDs of the representatives who are working with the company.
  - `statusId` integer: The identifier for the company status.
  - `status` string: The company status.
  - `statusType` string: The company status type.
  - `industry` string: The company industry.
  - `createdDate` string, date-time: The date the company profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.
  - `lastUpdatedDate` string, date-time: The date of the most recent update to the company profile. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.
  - `latestActivityDate` string, date-time: The date of the company's latest activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.
  - `latestActivityName` string: The name of the company's latest activity.
  - `openJobs` integer: The number of open jobs in the company.
  - `phoneNumber` string: The phone number of the company.
  - `fax` string: The fax number of the company.
  - `webSite` string: The website of the company.
  - `origin` string: The partner or vendor that originated the request.
  - `originRecordId` string: The identifier for the company that can be used to link the record within the originating system.
  - `weekEndDay` string: The Week End Day of the company. Valid values are 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', and 'Sunday'.
  - `payPeriod` string: The Pay Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.
  - `payCycle` string: The Pay Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.
  - `billingPeriod` string: The Bill Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.
  - `billingCycle` string: The Bill Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.
  - `isParent` boolean: Indicates whether the company is a parent company.
  - `parentCompanyId` integer: The identifier for the parent company if this company is a child.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `406`: Unsupported format(s) indicated by Accept header
- `415`: Unsupported format(s) indicated by the Content-Type header
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/bold-front-office-api.md) - [All operations](https://skmtc.dev/avionte/apis/bold-front-office-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/bold-front-office-api/revisions/bd5996cbaa0f?raw)