Get Companies

GET https://api.truework.com/companies/

The company search endpoint can be used to find a company by name or domain URL.

Request

Query Parameters

PARAMETERTYPEREQUIREDDEFAULTDESCRIPTION
qstringA string to match against company names
limitnumber25Filter results by state
offsetnumber0Filter results by state

Response

Response Body

PROPERTYTYPENULLABLEDESCRIPTION
resultsCompanySearchResult[]The list of companies that match the query
countnumberTotal number of results
nextstringURL for next page of results
previousstringURL for previous page of results

Examples

$ curl 'https://api.truework.com/companies/?q=widgets' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken' \
-H 'Content-Type: application/json'
{
"results": [
{
"id": 57,
"name": "Bob's Widgets"
},
{
"id": 1234,
"name": "Future Widget LLC",
"domain": "futuristic-widgets.example.com"
},
{
"id": 4545,
"name": "National Pizza With Extras LLC",
"domain": "widgets-and-pizza.example.com"
}
],
// ... Further 22 results omitted in example
"next": "https://api.truework.com/companies/?q=widgets&offset=25",
"count": 44
}