v1
latestOpenAPI 3.1.02026-07-2489171167.4 KBCompanies
Get List of Companies
Retrieve a list of companies configured in your SysAid account.
get/companies
Query parameters
limitinteger
The number of items to display per page. The default is 100, and you can have up to 500.
offsetinteger
The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).
querystring
The string by which to search companies.
namestring
The name (partial or whole) companies filter.
idinteger[]
The ID companies filter.
statestring
The state (partial or whole) companies filter.
citystring
The city (partial or whole) companies filter.
countrystring
The country (partial or whole) companies filter.
addressstring
The address (partial or whole) companies filter.
agreementIdinteger[]
The agreement ID companies filter.
sortBy'id' | 'name' | 'address' | 'address2' | 'city' | 'state' | 'country' | 'zip' | 'phone' | 'fax' | 'emailAccount' | 'agreementId' | 'expirationDate' | 'agreementStartDate' | 'agreementEndDate'
The property by which companies are sorted.
sortDir'asc' | 'desc'
The direction in which companies are sorted.
Response
Returns a list of companies.
Example response
{
"limit": 20,
"total": 50,
"data": [
{
"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
}
]
}