List RMAs
GET/api/rmas
List all RMAs with pagination, filtering, and sorting via Spatie QueryBuilder.
returns:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Filter system: Uses Spatie QueryBuilder filter syntax.
- filter[search]: Searches rma_number and related sales_order_number
- filter[status]: draft | approved | in_transit | received | closed | canceled
- filter[customer_id]: Filters via associated sales order
- filter[sales_order_id]: Exact match
- Advanced text filters: filter[rma_number][is], [is_not], [contains], [does_not_contain], [starts_with], [ends_with], [is_empty], [is_not_empty]
- Advanced date filters: filter[rma_date][from], [to], filter[created_at][from], [to]
Allowed sorts: rma_number, status, rma_date, created_at. Default sort: -created_at.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.