Jobs

Poll an async job

Returns the current status and result counters of a job created by POST /api/v1/imports/contacts or POST /api/v1/imports/tickets. A contacts_import job needs a key with public_api; a tickets_import job needs a key with tickets:import. Jobs are retained for 7 days; unknown, expired, and cross-organization ids all answer 404. Poll with backoff (a 1,000-item import typically completes within a minute).

get/api/v1/jobs/{id}

Request

  • Base URL: https://api.agendaforge.app
  • URL: https://api.agendaforge.app/api/v1/jobs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

The jobId returned by the 202 response.

Response

The job with live progress counters. The shape depends on the job type.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.