How can we help?

Search

Overview

The Jobs resource contains all background Job activity and status for retrieval via GET calls.

API set name: jobs

Additional information

• Jobs are generated by the application to manage and track contact imports and exports using the Contact import and Contact export APIs.
• The Job information includes Job status, Job ID, Job name, total items, completed items and start and end times.
• For import Jobs specifically, Jobs also include total records, number updated, number inserted, number rejected, duplicate records, invalid records and new records.
• Job names and IDs are given to the job automatically based on the API initiating the job type. For example, contactimports will assign the value of ImportContacts to the jobName.
• Jobs can have a status of Scheduled, Pending, Processing, Failed, and Done.
• Jobs records are retained for 60 days.
• Job rejections and import rejections are downloadable in the UI.
• Job rejections are retained for 7 days.

Authentication

Cordial's core APIs use HTTP Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account and use it for authorization.

• Learn more about Cordial API authentication here.

Resource associations

The following resource collections are associated to this collection.

Methods, parameters, and examples

• GET/v2/jobs
• GET/v2/jobs/{ID}

GET/v2/obs

• Query string parameters
• Example request URLs

The following URL will retrieve all jobs and include all fields.

https://<path>/v2/jobs

The following URL will retrieve the job with the jobName of ImportContacts.

https://<path>/v2/jobs?jobName=ImportContacts

The following URL will retrieve all jobs, but will only include jobs that have a status of Failed.

https://<path>/v2/jobs?status=Failed

The following URL will retrieve all jobs starting from the third page grouping jobs by 10. For example, page-1 would include the first 10, page-2 the second group of 10, and so on.

https://<path>/v2/jobs?page=3&per_page=10

GET/v2/jobs/{id}

The following URL will retrieve the job with the ID value of 123123.

https://<path>/v2/jobs/123123

Error responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Jobs API endpoint, along with suggested modifications to resolve each error. If you receive an error from the Jobs API endpoint that is not listed in this table, it is likely recorded within the Global API Error Responses page.