Skip to content

List all orders

Request

Returns a list of your orders. The orders are returned sorted by creation date, with the most recent order appearing first.

Security
JWT
Query
customer_idstring

Orders of customer to filter

statusstring

Return only orders in this status. Uses the same values as the order's status field.

Enum:"active""action_required""under_review""paid""failed""cancelled""expired"
request_idstring

Return only the order created with this request_id.

Example:request_id=unique_order_request_id_123
beforestring

Return only resources created at or before this time. Send an ISO 8601 timestamp with an offset, such as 2025-02-18T12:03:44Z or 2025-02-18T17:33:44+05:30. A timestamp without an offset is read as UTC. A bare date (YYYY-MM-DD) means the end of that day in UTC (23:59:59.999999Z). An invalid value returns 400 Bad Request. Use this to avoid page drift. See Pagination parameters for more details.

Example:before=2025-02-18T12:03:44Z
afterstring

Return only resources created at or after this time. Send an ISO 8601 timestamp with an offset, such as 2025-01-18T12:03:44Z or 2025-01-18T17:33:44+05:30. A timestamp without an offset is read as UTC. A bare date (YYYY-MM-DD) means the start of that day in UTC (00:00:00Z). An invalid value returns 400 Bad Request. Use this to avoid page drift. See Pagination parameters for more details.

Example:after=2025-01-18T12:03:44Z
per_pageinteger

Number of resources per page. Should be between 1 and 100.

Default:20
pageinteger

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Default:1
curl -i -X GET \
  'https://api.glomopay.com/api/v1/orders?customer_id=string&status=active&request_id=unique_order_request_id_123&before=2025-02-18T12%3A03%3A44Z&after=2025-01-18T12%3A03%3A44Z&per_page=20&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of orders matching the filters

Bodyapplication/json
dataArray of objects(OrderResponse)
page_metaobject(PageMeta)
Response
{ "data": [ { … } ], "page_meta": { "current": 2, "previous": 1, "next": 3, "per_page": 20, "pages": 10, "count": 200 } }