List import batches

get

https://ecm.cert.ceretax.net/customers/imports

Retrieves the customer import batches associated with your account.

Unlike List customers, this response is a plain JSON array and is not wrapped in a pagination envelope. The sort parameter is not supported by this endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

The page parameter defines the specific page of results you want returned in the response. This is a 1-based value.

perPage

integer

1 to 100

Defaults to 10

The perPage parameter controls how many import batch records are included in each page of the result set. The default is 10 and the max is 100.

status

string

enum

Restricts results to import batches in this state.

pending-Registered, awaiting file upload
processing-File received and being validated and applied
completed-Every row succeeded
completed_with_errors-Some rows failed and an error file is available
failed-The batch could not be processed

Allowed:

createdBy

string

Restricts results to import batches created by this user. This value is matched case-insensitively.

createdFromDate

string

The inclusive lower bound on the batch creation date. Preferred format is YYYY-MM-DD. MM/DD/YYYY can also be used. This value must be less than or equal to createdToDate.

createdToDate

string

The inclusive upper bound on the batch creation date. Preferred format is YYYY-MM-DD. MM/DD/YYYY can also be used.

Responses

204

No import batches matched the request.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

422The request could not be processed.

500An internal error occurred.