Contractor contact role types

Contractor contact role types are used to categorize contractor members. Use the API to retrieve a list of role types set up at your organization.

Learn more about role types in the OnLocation Help Center.

List all contact role types

Returns a list of all of the contractor contact roles created for your organization.

A comma separated list of tag:value search parameters, a colon separator performs an exact match and a percent separator performs a starts-with search.

Request

query Parameters

q	string <string> Filter by any contractor role value Example: q=name:ACME
order	string <string> Specifies an element to order by. Order by any element returned, prefix with a - to reverse order. Example: order=id
limit	integer <int32> Limits the number of records to return Example: limit=10

header Parameters

If-Modified-Since

string <int32>

A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only entities created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Responses

200

List of contractor roles

403

Access denied to this resource

404

Resource not found

500

Internal server error

get/sp/role

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api.whosonlocation.com/v1/sp/role?q=string&order=string&limit=0' \
  -H 'If-Modified-Since: string'

Response samples

[{"role": [{"id": 556,
"name": "Example Name"
}
]
}
]