Skip to main content
GET
/
v1
/
actors
List Actors
curl --request GET \
  --url https://api.corpus.intrace.ai/v1/actors \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "canonicalName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "aliases": [
        "<string>"
      ],
      "description": "<string>",
      "articleCount": 0,
      "eventCount": 0,
      "sourceDomains": [
        "<string>"
      ],
      "firstMentionDate": "2023-12-25",
      "lastMentionDate": "2023-12-25"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

X-API-Key
string
header
required

Headers

x-api-key
string | null

Corpus API key

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: 1 <= x <= 500
all_results
boolean
default:false

Return all results without pagination

actor_type
string[]

Filter by actor type (repeatable)

country
string[]

Filter by country (repeatable)

search
string | null

Search in canonical name

event_count_min
integer | null

Minimum event count

Required range: x >= 0
event_count_max
integer | null

Maximum event count

Required range: x >= 0
article_count_min
integer | null

Minimum article count

Required range: x >= 0
article_count_max
integer | null

Maximum article count

Required range: x >= 0
sort_by
string
default:canonical_name

Sort column

sort_order
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
api_key
string | null

Corpus API key

Response

Successful Response

Paginated list of actors.

items
ActorResponse · object[]
required
total
integer
required
page
integer
required
pageSize
integer
required
totalPages
integer
required