importers

Retrieve a Batch Job

Retrieve the status and counts for an existing Batch Job.

get/batch-jobs/{batch-job-id}

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/batch-jobs/{batch-job-id}
  • Auth: HTTP bearer

Path parameters

batch-job-idstring required

The ID of the Batch Job.

Query parameters

includestring

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns a Batch Job resource.

Changes

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