Skip to main content

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
limitnumber25Limit the number of results returned
offsetnumber0Offset query by a number of results

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#

Request#

$ curl 'https://api.truework.com/companies/?q=widgets&limit=10' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken' \
-H 'Content-Type: application/json'

Response#

{
"results": [
{
"id": 57,
"name": "Bob's Widgets"
},
{
"id": 1234,
"name": "Future Widgets LLC",
"domain": "futuristic-widgets.example.com"
},
// ... Further 7 results omitted in example
{
"id": 4545,
"name": "National Pizza With Extras LLC",
"domain": "widgets-and-pizza.example.com"
}
],
"next": "https://api.truework.com/companies/?q=widgets&limit=10&offset=10",
"count": 44
}