Contractors: list

Return information about all contractors in a company.

Request - GET https://api-uat.vtopenview.com/contractors

DO NOT supply a request body and a request parameter with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- GET Base URI: https://api-uat.vtopenview.com/contractors --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK Content-Type: application/json { "contractors": [ { "contractorid": long, "companyname": "string", "website": "string", "phone": "string", "workphone": "string", "mobilephone": "string", "email": "string", "publicliabilityrequired": boolean, "publicliabilityexpirydate": "date", "reference": "string", "status": "string", "ModifiedDate": "date", "negotiator": { "userid": long, "name": "string", "email": "string" }, "archived": boolean, "contactnotes": "string", "services_provided": [ { "service": "string", } ], "branches_serviced": [ { "branchid": integer, "branchname": "string" } ], "udf": [ { "udfid": long, "fieldName": string, "dataType": string, "value": string, "required": boolean, "options": [ { "text": string, "value": integer } ] } ] } ] }

UDF Data type:

The list below describes the possible date type of UDFs.

text
integer
datetime
datetime
decimal
money
percentage
yes/no
select
multi

Example field on response:

{ ... "dataType": "decimal", "value": "0.00" }, { ... "dataType": "multi", "value": "1,2" "options": [ { "text": "Ensuite Bathroom", "value": 1 }, { "text": "Central Heating", "value": 2 } ] },