Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Get a Company

Returns details about the specified company.

get/v1/company/{companyId}

Path parameters

companyIdstring required

An identifier for the company being retrieved.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The retrieved company record.

idinteger

The identifier for the company.

namestring

The name of the company.

frontOfficeIdinteger

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.

linkstring

The BOLD URL of the company.

isArchivedboolean

An indication of whether the company record is archived or not.

representativeUsersinteger[]

The IDs of the representatives who are working with the company.

statusIdinteger

The identifier for the company status.

statusstring

The company status.

statusTypestring

The company status type.

industrystring

The company industry.

createdDatestring 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.

lastUpdatedDatestring 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.

latestActivityDatestring 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.

latestActivityNamestring

The name of the company's latest activity.

openJobsinteger

The number of open jobs in the company.

phoneNumberstring

The phone number of the company.

faxstring

The fax number of the company.

webSitestring

The website of the company.

originstring

The partner or vendor that originated the request.

originRecordIdstring

The identifier for the company that can be used to link the record within the originating system.

weekEndDaystring

The Week End Day of the company. Valid values are 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', and 'Sunday'.

payPeriodstring

The Pay Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.

payCyclestring

The Pay Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.

billingPeriodstring

The Bill Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.

billingCyclestring

The Bill Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.

isParentboolean

Indicates whether the company is a parent company.

parentCompanyIdinteger

The identifier for the parent company if this company is a child.

Example response

{
  "id": 12345,
  "name": "Acme Corporation",
  "mainAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  },
  "billingAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  },
  "frontOfficeId": 12353,
  "link": "https://abc.myavionte.com/app/#/company/12345",
  "representativeUsers": [
    18394,
    18402
  ],
  "statusId": 184,
  "status": "Active",
  "statusType": "General",
  "industry": "Information Technology",
  "latestActivityName": "Meeting",
  "openJobs": 15,
  "phoneNumber": "800-555-0199",
  "fax": "800-555-0198",
  "webSite": "https://www.acmecorp.com",
  "origin": "PartnerX",
  "originRecordId": "12345-abcde",
  "weekEndDay": "Friday",
  "payPeriod": "BiWeekly",
  "payCycle": "Last Week",
  "billingPeriod": "Monthly",
  "billingCycle": "2",
  "isParent": true,
  "parentCompanyId": 13839
}