Skip to content
Survey Coder Pro Survey Coder Pro

List recent jobs

GET
/v2/jobs
 
curl --request GET \
  --url 'https://api.surveycoder.io/v2/jobs?status=queued&limit=20' \
  --header 'x-api-key: <x-api-key>'

List async jobs for your organization, sorted by creation time (newest first). Optionally filter by status.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
string
Allowed values: queued processing completed failed

Filter jobs by status.

limit
integer
default: 20 >= 1 <= 100

Maximum number of jobs to return (1-100).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of jobs

Media type application/json
object
success
required
boolean
data
required

Jobs for this organization.

Array<object>

Abbreviated job info for list views (no result payload).

object
id
required

Unique job identifier.

string
type
required

Kind of background work.

string
Allowed values: codebook_generation auto_coding one_call
status
required

Current job status.

string
Allowed values: queued processing completed failed
progress
required

Progress counters for the job.

object
processed
required

Number of items processed so far.

integer
total
required

Total number of items to process.

integer
percentage
required

Completion percentage (0-100).

integer
<= 100
created_at
required

ISO 8601 timestamp when the job was created.

string format: date-time
updated_at
required

ISO 8601 timestamp of the last status update.

string format: date-time
meta
required
object
api_version
string
count

Number of jobs returned.

integer
Example 
{
  "success": true,
  "data": [
    {
      "type": "codebook_generation",
      "status": "queued",
      "progress": {
        "processed": 120,
        "total": 500,
        "percentage": 24
      }
    }
  ],
  "meta": {
    "api_version": "v1"
  }
}

401

Section titled “401 ”

Missing or invalid API key.

Media type application/json

Standard error envelope.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code. See the error reference for the full list.

string
message
required

Human-readable explanation of what went wrong.

string
request_id

Echo of the X-Request-Id header, when provided.

string format: uuid
doc_url

Link to documentation for this specific error code.

string format: uri
Example 
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "x-api-key header is required",
    "doc_url": "https://docs.surveycoder.io/errors/unauthorized"
  }
}