API Reference

List Companies

get
https://{workspace}.api.vitruvi.cc/api/v1/companies/

Returns a list of all companies including network operators, subcontractors and EPCs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Select only the company with the specified code. For more flexible search options, use the search parameter.

string

A comma-delimited list of fields that should be returned in the API call. If the fields parameter is omitted or empty, all fields will be returned.

If any of the fields listed in the fields parameter do not exist, these fields will be ignored and only the fields that do exist in the dataset will be returned. No error will be raised if field names are included that do not exist in the data set.

string

A generic expression to filter the list with.

boolean

Set to true to only list active companies.

integer
Defaults to 1000

The number of records returned in the single call. See API Paging.

integer
Defaults to 0

The number of records to skip. The offset value is usually equal to the page_number * limit. See API Paging.

string

Which field to use when ordering the results.

string

A term that will be (case-insensitive) searched for in each of the fields: ('name', 'code', 'description')

string
enum

Type can be one of 'NO' (network operator), 'SC' (subcontractor) or 'EPC'.

Allowed:
integer

Filter companies of any type that no have a Subcontract within the same Program. Enter the Program ID to filter the list of companies by.

integer

Filter companies of any type that have a Subcontract within the same Program, or the EPC Company itself. Enter the Program ID to filter the list of companies by.

Response

Updated 8 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago