Skip to main content
GET
List intel

Authorizations

api_key
string
header
required

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0
orderBy
enum<string>
default:createdAt

Field used to order matching intel (default: createdAt).

Available options:
createdAt,
updatedAt,
name
sortDirection
enum<string>
default:desc

Sort direction (default: desc).

Available options:
asc,
desc
intelTargetType
enum<string>

Only return intel for this target type: segment, competitor, or workspace_company.

Available options:
segment,
competitor,
workspace_company
intelTargetOIds
Minimum string length: 1
updatedSince
string<date-time>

Return records updated after this ISO timestamp. Revalidation also updates timestamps; this is a sync filter, not an activity count.

lifecycleStatuses
Available options:
ACTIVE,
INVALIDATED,
EXPIRED
hydrate
enum<string>
default:false
Available options:
true,
false

Response

200 - application/json

Intel

_metadata
object
required
intel
object[]
required

The requested page of intel.

total
number
required

Total intel items matching the filters.

hasNext
boolean
required

Whether there are more matching intel items after this page.

limit
number
required

Maximum results per page.

offset
number
required

Current pagination offset.

intelEnabled
boolean
required

False when Intel is turned off for every target type in Library Settings.

hydrated
boolean
required

Whether detail is populated on each item.