Tracking
List tracked companies
/api/v1/tracking/companies
List tracked companies
Returns tracked companies visible to the authenticated account set. Supports bearer token auth.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
accountId |
query | integer[] | Filter by one or more internal account ids. |
accountExternalId |
query | string[] | Filter by one or more external account ids. |
agentId |
query | integer[] | Filter by one or more tracking agent ids. |
query |
query | string | Search company name, domain, website, and industry. |
domain |
query | string[] | Filter by one or more exact company domains. |
industry |
query | string[] | Filter by one or more exact industries. |
lastSeenAt |
query | string | Filter to companies last seen at this exact ISO timestamp. |
lastSeenAt[gte] |
query | string | Filter to companies last seen at or after this ISO timestamp. |
lastSeenAt[lte] |
query | string | Filter to companies last seen at or before this ISO timestamp. |
sessions |
query | integer | Filter to companies with exactly this many sessions. |
sessions[gte] |
query | integer | Filter to companies with at least this many sessions. |
sessions[lte] |
query | integer | Filter to companies with at most this many sessions. |
cursor |
query | string | Opaque cursor returned by the previous page. |
limit |
query | integer | Maximum number of companies to return. |
sort |
query | string | Field used to sort the page. |
order |
query | string | Sort direction. |
Responses
| Status | Schema | Description |
|---|---|---|
200 |
TrackingCompanyList | Tracked company page |
400 |
Error | Invalid query params |
401 |
Error | Missing or invalid auth |
403 |
Error | Requested filter falls outside the caller scope |
Example 200 response
{
"data": [
{
"id": 1,
"name": "string",
"domain": "string",
"website": "string",
"industry": "string",
"employeeRange": "string",
"annualRevenue": "string",
"totalFunding": "string",
"location": "string",
"description": "string",
"phone": "string",
"profiles": null,
"type": "string",
"firstSeenAt": "string",
"lastSeenAt": "string",
"sessionCount": 1,
"account": {
"id": 1,
"externalId": "string",
"name": "string",
"parentId": 1
},
"agent": {
"id": 1,
"name": "string"
}
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "string"
}
}
Example 400 response
{
"error": "string",
"message": "string"
}
Example 401 response
{
"error": "string",
"message": "string"
}
Example 403 response
{
"error": "string",
"message": "string"
}