Get Export Custom Object Jobs

GET /bulk/v1/customobjects/{apiName}/export.json

Returns a list of export jobs that were created in the past 7 days.

Operation ID: getExportCustomObjectsUsingGET
Permissions: Read-Only Custom Object
Request format: application/json
Returns: ResponseOfExportResponseWithToken

Parameters

Path 1

apiName string required

API Name of the custom object for the export batch job.

Query 3

status array of string

Comma separated list of statuses to filter on.

Values created queued processing cancelled completed failed

batchSize integer (int32)

The batch size to return. The max and default value is 300.

nextPageToken string

A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Responses

200 OK ResponseOfExportResponseWithToken

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of ExportResponse required

Array of results for individual records in the operation, may be empty

Model ExportResponse

createdAt string (date-time)

Date when the export request was created

errorMsg string

Error message in case of "Failed" status

exportId string required

Unique id of the export job

fileSize integer (int64)

Size of exported file in bytes. This will have a value only when status is "Completed", otherwise null

fileChecksum string

SHA-256 hash of exported file. This will have a value only when status is "Completed", otherwise null

finishedAt string (date-time)

Finish time of export job. This will have value only when status is "Completed" or "Failed", otherwise null

format string

Format of file as given in the request ("CSV", "TSV", "SSV")

numberOfRecords integer (int64)

Number of records in the export file. This will have value only when status is "Completed", otherwise null

queuedAt string (date-time)

Queue time of export job. This will have value when "Queued" status is reached, before that null

startedAt string (date-time)

Start time of export job. This will have value when "Processing" status is reached, before that null

status string required

Status of the export job ("Created","Queued","Processing","Canceled","Completed","Failed")

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "createdAt": "2026-01-15T10:30:00Z",
      "errorMsg": "string",
      "exportId": "123",
      "fileSize": 123,
      "fileChecksum": "string",
      "finishedAt": "2026-01-15T10:30:00Z",
      "format": "string",
      "numberOfRecords": 123,
      "queuedAt": "2026-01-15T10:30:00Z",
      "startedAt": "2026-01-15T10:30:00Z",
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.