Skip to main content
GET
List merge batches (paginated)

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

hysform_id
integer

Restrict to one donor form.

Search batch reference, status, operator, or donor identity before pagination.

Maximum string length: 120
status
enum<string>

Restrict history to one batch status.

Available options:
completed,
undone,
failed,
processing,
pending
date
string<date>

Restrict history to the calendar day shown to the administrator.

timezone
string

IANA timezone used to calculate exact calendar-day boundaries, including daylight-saving transitions.

Example:

"America/New_York"

timezone_offset_minutes
integer

Offset fallback for clients that do not provide an IANA timezone. Use the offset on the selected date.

Required range: -840 <= x <= 840

Response

Paginated batches.

Standard Laravel LengthAwarePaginator JSON envelope. The data array contains the page's items and is the only field whose shape varies per endpoint — wrap this schema in an allOf and override data to point at the resource type. The remaining fields are paginator metadata.

current_page
integer
required

1-indexed current page number.

Example:

1

data
object[]
required

Page items. Override this in endpoint-specific schemas with a $ref to the resource type.

per_page
integer
required

Page size.

Example:

25

total
integer
required

Total number of items across all pages.

Example:

287

first_page_url
string<uri>
Example:

"https://api.gratona.com/v1/donors?page=1"

from
integer | null

1-indexed position of the first item on this page (null when the page is empty).

Example:

1

last_page
integer

Total number of pages.

Example:

12

last_page_url
string<uri>
Example:

"https://api.gratona.com/v1/donors?page=12"

next_page_url
string<uri> | null
Example:

"https://api.gratona.com/v1/donors?page=2"

path
string<uri>
Example:

"https://api.gratona.com/v1/donors"

prev_page_url
string<uri> | null
Example:

null

to
integer | null

1-indexed position of the last item on this page (null when the page is empty).

Example:

25

Pagination link objects emitted by Laravel's paginator (sometimes present, sometimes omitted depending on the endpoint).