Filter Terminals
Returns a paginated list of terminals for the authenticated merchant with search capabilities.
This endpoint provides full-text search functionality using the SearchIndex infrastructure, allowing you to search terminals by name, external ID, and branch name.
per_page
number
Optional. Number of terminals to return per page. Default: 10, Maximum: 100
page
number
Optional. Page number for pagination. Default: 1 (first page)
terms
string
Optional. Full-text search across terminal content. Searches terminal name, external ID, and branch name. Uses fuzzy matching for partial text matches.
| Attribute | Description |
|---|---|
previousobject
|
Pagination for the previous page. Contains 'before' (page number) and 'perpage' (page size) parameters. Use these values in the 'page' and 'perpage' parameters of the next request to get the previous page. Returns null if there is no previous page. |
pagearray
|
The current page of records, ordered by creation date (newest first). Each record is serialized according to the specified record_serializer option. |
nextobject
|
Pagination for the next page. Contains 'after' (page number) and 'perpage' (page size) parameters. Use these values in the 'page' and 'perpage' parameters of the next request to get the next page. Returns null if there is no next page. |
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.