v1/mcp/import/batch

get

https://shyftplan.com/api/v1/mcp/import/batch

Read a staged or executed import batch, one page of rows at a time.

Query Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

batch_id

int32

required

≥ 1

ID of the object.

entity

string

enum

Allowed:

classification

string

enum

Page through just the rows with this verdict, e.g. error, to fix a sheet.

Allowed:

limit

int32

≥ 1

Defaults to 50

ID of the object.

offset

int32

Defaults to 0

Responses

200

Batch header, summary and a page of rows

401

401 Unauthorized

403

Forbidden - caller cannot manage this company

404

Company or batch not found