Skip to main content
GET
List tracked keywords

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

project_id
string<uuid>
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:25

Items per page

Required range: 1 <= x <= 100
search
string | null

Filter by keyword substring

tag_id
string<uuid> | null

Filter by tag UUID

only_active
boolean
default:true

If true, return only active keywords; if false, include paused

Response

Successful Response

data
TrackedKeywordResponse · object[]
required
meta
PaginationMeta · object
required

Pagination metadata included in list responses.

success
boolean
default:true