Skip to main content
GET
List Keywords
Returns one page of keywords from the token’s workspace. Use it to read the ranks Slate already tracks, for example to copy them into a spreadsheet once a day. This endpoint only reads data.
Every request needs an API token in the Authorization header. The token decides the workspace.

Parameters

string
required
Bearer token. Format: Bearer slat_<your-token>.
string
Filter by tracking status. One of: tracked, paused. Leave it out to get both.
Return keywords whose text contains this value.
string
Return keywords tracked in this country, for example US.
string
Start of the period for average ranks, in YYYY-MM-DD format. Send it together with to. Default: 14 days ago.
string
End of the period for average ranks, in YYYY-MM-DD format. Default: today (UTC).
string
Sort field. One of: keyword, latestRank, avgRank, volume, clicks, impressions, ctr.
string
default:"asc"
Sort direction. One of: asc, desc. Used with sortBy.
integer
default:"1"
Page number, starting at 1.
integer
default:"20"
Keywords per page. Range: 1–200. A value outside the range falls back to 20.

Response

Returns 200 OK with this object:
object[]
required
The keywords on this page.
number
required
Number of keywords that match the filters, across all pages.
number
required
The page returned.
number
required
Keywords per page.
object
required
The periods used for avgRank and previousAvgRank.

Errors

See Errors for the response format.

Example