Skip to main content
GET
/
api
/
v1
/
jobs
List current user's jobs
curl --request GET \
  --url https://www.suprkeywords.com/api/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "jobs": [
    {
      "id": "<string>",
      "status": "<string>",
      "primaryDomain": "<string>",
      "competitorDomains": [
        "<string>"
      ],
      "languageCode": "<string>",
      "locationCode": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "progress": {},
      "errorMessage": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.suprkeywords.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Query Parameters

​
limit
integer
default:50

Max jobs to return

Required range: x <= 100
​
offset
integer
default:0

Pagination offset

​
status
enum<string>

Filter by job status

Available options:
queued,
running,
completed,
failed

Response

List of jobs and total count

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