Skip to main content
GET
List Batch Jobs

Overview

Retrieves all batch calling jobs for an organization with optional filtering by status. Supports pagination for large result sets.

Request

Query Parameters

Status Filter Values

Response

Response Fields

Batch Job Object

Examples

Example 1: List All Jobs

Example 2: Filter by Running Status

Example 3: Paginated Results

Example 4: List Completed Jobs

Error Handling

400 Bad Request

500 Internal Server Error

Pagination

The API uses offset-based pagination:
Calculate total pages:
Example:
  • Total: 47 jobs
  • Page size: 20
  • Total pages: 3

Authorizations

Authorization
string
header
required

Your TalkifAI API key. Get it from Studio → Settings → API Keys.

Query Parameters

organizationId
string
required

Organization ID to filter by

status
enum<string>

Filter by job status

Available options:
pending,
scheduled,
running,
completed,
failed,
cancelled
page
integer
default:1

Page number

Required range: x >= 1
pageSize
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

List of batch jobs

batchJobs
object[]
total
integer
Example:

47

page
integer
Example:

1

pageSize
integer
Example:

20