Skip to main content
POST
/
api
/
jobs
/
list
List jobs
curl --request POST \
  --url https://api.mentionlab.io/api/jobs/list \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "status": "completed",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "sort": [
    {
      "field": "createdAt",
      "direction": "DESC"
    }
  ]
}
'
{
  "page": {
    "totalRecords": 123,
    "limit": 123,
    "currentPage": 123,
    "totalPages": 123,
    "nextPage": 123,
    "prevPage": 123
  },
  "results": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "project": "01234567-89ab-cdef-0123-456789abcdef",
      "totalExecutions": 100,
      "pendingExecutions": 10,
      "retryingExecutions": 2,
      "successExecutions": 80,
      "failedExecutions": 8,
      "status": "processing",
      "createdAt": "2026-06-08T12:00:00.000Z",
      "updatedAt": "2026-06-08T12:30:00.000Z",
      "createdBy": {
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane.doe@example.com",
        "id": "01234567-89ab-cdef-0123-456789abcdef"
      }
    }
  ]
}

Headers

​
x-project-id
string
required

Project ID to specify the project context

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 100
​
page
integer
default:1
Required range: x >= 1

Body

application/json
​
status
enum<string>

Filter the jobs by their processing status.

Available options:
pending,
processing,
completed,
failed,
partial_failed
Example:

"completed"

​
createdBy
string

Filter the jobs by the identifier of the user who created them.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
sort
object[]

Sorting criteria for the returned jobs. Each entry pairs a sortable field (createdAt, updatedAt or status) with a direction (ASC or DESC). Defaults to sorting by creation date descending.

Example:
[
  { "field": "createdAt", "direction": "DESC" }
]

Response

​
page
object
required
​
results
object[]