Skip to main content
GET
/
api
/
v1
/
jobs
/
{jobId}
/
keywords
Get keywords for a job
curl --request GET \
  --url https://www.suprkeywords.com/api/v1/jobs/{jobId}/keywords \
  --header 'Authorization: Bearer <token>'
{
  "keywords": [
    {}
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

API key for programmatic access. Create keys in Settings (Agency plan). Send as Authorization: Bearer or X-API-KEY: . Unauthenticated requests return 401.

Path Parameters

​
jobId
string<uuid>
required

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0
​
search
string

Search keyword phrase (case-insensitive)

​
intent
string

Comma-separated intent filter (informational, commercial, transactional, navigational)

​
minVolume
integer
Required range: x >= 0
​
maxVolume
integer
Required range: x >= 0
​
minDifficulty
integer
Required range: 0 <= x <= 100
​
maxDifficulty
integer
Required range: 0 <= x <= 100
​
personaAvatarNames
string

Comma-separated persona avatar names (or none for keywords with no persona)

​
minCpc
number
Required range: x >= 0
​
maxCpc
number
Required range: x >= 0
​
minCompetition
number
Required range: 0 <= x <= 1
​
maxCompetition
number
Required range: 0 <= x <= 1
​
minOrganicOpportunityScore
number
Required range: x >= 0
​
maxOrganicOpportunityScore
number
Required range: x >= 0
​
minPaidOpportunityScore
number
Required range: x >= 0
​
maxPaidOpportunityScore
number
Required range: x >= 0
​
minOpportunityValue
number
Required range: x >= 0
​
maxOpportunityValue
number
Required range: x >= 0
​
sortBy
string
default:organicOpportunityScore
​
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated keywords and total count

​
keywords
object[]
​
total
integer
​
limit
integer
​
offset
integer