Get List of Companies

get

https://{account}.sysaidit.com/connect/v1/companies

Retrieve a list of companies configured in your SysAid account.

Query Params

limit

integer

1 to 500

Defaults to 100

The number of items to display per page. The default is 100, and you can have up to 500.

offset

integer

≥ 0

Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

query

string

length ≥ 1

The string by which to search companies.

name

string

length ≥ 1

The name (partial or whole) companies filter.

array of integers

length ≥ 1

The ID companies filter.

state

string

length ≥ 1

The state (partial or whole) companies filter.

city

string

length ≥ 1

The city (partial or whole) companies filter.

country

string

length ≥ 1

The country (partial or whole) companies filter.

address

string

length ≥ 1

The address (partial or whole) companies filter.

agreementId

array of integers

length ≥ 1

The agreement ID companies filter.

agreementId

sortBy

string

enum

The property by which companies are sorted.

sortDir

string

enum

The direction in which companies are sorted.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns a list of companies.

401Authentication information is missing or invalid