List jobs - SmartlyQ

GET

jobs

List jobs

curl --request GET \
  --url https://api.smartlyq.com/v1/jobs \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "result": {},
      "error": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "pages": 123
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

API key from Developer dashboard (Bearer token).

Query Parameters

page

integer

default:1

Page number (1-based).

Required range: x >= 1

per_page

integer

default:20

Items per page.

Required range: 1 <= x <= 100

status

enum<string>

Available options:

pending,

processing,

completed,

failed,

cancelled

type

string

Filter by job type

Response

Paginated list of jobs

success

enum<boolean>

Available options:

true

data

object[]

Show child attributes

pagination

object

Show child attributes

meta

object

Show child attributes

Get job

List jobs

curl --request GET \
  --url https://api.smartlyq.com/v1/jobs \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "result": {},
      "error": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "pages": 123
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}