Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Companies

Get Company by ID

Retrieve a company by its ID.

get/companies/{companyId}

Response

The company is found by the specified ID.

namestring nullable

Name of the company.

addressstring nullable

Main company address.

address2string nullable

Additional company address.

citystring nullable

The city in which the company is located.

statestring nullable

The state in which the company is located.

zipstring nullable

The company's zip code.

countrystring nullable

The country in which the company is located.

phonestring nullable

The company’s phone number.

faxstring nullable

The company’s fax number.

notesstring nullable

Notes related to the company.

emailAccountstring nullable

Default email account.

expirationDatestring date nullable

The date when the company's access to the help will expire.

agreementIdinteger nullable

The ID of the SLA applied to the company.

agreementStartDatestring date nullable

The start date of your service agreement with the company.

agreementEndDatestring date nullable

The end date of your service agreement with the company.

customFieldsobject

Company custom fields.

versioninteger required

The latest retrievable version of the company and its details.

idinteger required

The unique identifier of the company in SysAid.

Example response

{
  "name": "Alpha",
  "address": "123 Main Street",
  "address2": "Apt. 4B",
  "city": "Washington",
  "state": "Virginia",
  "country": "USA",
  "fax": "555-555-1234",
  "notes": "Some notes about the company.",
  "emailAccount": "company@mail.com",
  "expirationDate": "30-12-2120",
  "agreementId": 5,
  "agreementStartDate": "22-10-2025",
  "agreementEndDate": "01-08-2024",
  "customFields": {
    "company_cust_int_field": 5
  },
  "version": 5,
  "id": 1
}