> ## Documentation Index > Fetch the complete documentation index at: https://docs.payra.com/llms.txt > Use this file to discover all available pages before exploring further. # List terminals > The card terminals assigned to your account in this environment, oldest first. Only terminals ready to take payments are listed; one still being set up does not appear until it is. `checked_out=false` lists the free ones. ## OpenAPI ````yaml /api-reference/openapi-v1.json get /terminals openapi: 3.1.0 info: title: Payra API version: v1 description: >- The Payra API. Authenticate with a secret key: `Authorization: Bearer sk_test_...`. The two payment method session endpoints Payra Elements calls also take a publishable key with the session's `client_secret`. servers: - url: https://api-dashboard.payra.com/v1 description: 'Sandbox and live: the key decides which' security: [] paths: /terminals: get: tags: - Terminals summary: List terminals description: >- The card terminals assigned to your account in this environment, oldest first. Only terminals ready to take payments are listed; one still being set up does not appear until it is. `checked_out=false` lists the free ones. parameters: - schema: type: integer minimum: 1 maximum: 100 default: 20 example: 20 description: How many to return, 1 to 100. required: false description: How many to return, 1 to 100. name: limit in: query - schema: type: string format: uuid example: 019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61 description: >- The `id` of the last terminal of the previous page; the page after it is returned. required: false description: >- The `id` of the last terminal of the previous page; the page after it is returned. name: starting_after in: query - schema: type: string minLength: 1 maxLength: 120 example: Truck 412 description: >- Only terminals with exactly this `label`. Applies before `starting_after`. required: false description: >- Only terminals with exactly this `label`. Applies before `starting_after`. name: label in: query - schema: type: string minLength: 1 maxLength: 64 example: '1853000123' description: >- Only terminals with exactly this `serial_number`. Applies before `starting_after`. required: false description: >- Only terminals with exactly this `serial_number`. Applies before `starting_after`. name: serial_number in: query - schema: type: string minLength: 1 maxLength: 120 example: PAY1018 description: >- Only terminals whose `label` starts with this, such as the terminals of one plant when names carry it. Applies before `starting_after`. required: false description: >- Only terminals whose `label` starts with this, such as the terminals of one plant when names carry it. Applies before `starting_after`. name: label_prefix in: query - schema: type: string enum: - 'true' - 'false' example: 'false' description: >- `false` lists only free terminals, `true` only checked-out ones. Applies before `starting_after`. required: false description: >- `false` lists only free terminals, `true` only checked-out ones. Applies before `starting_after`. name: checked_out in: query - schema: type: string minLength: 1 maxLength: 120 example: Tablet TB0011 description: >- Only terminals checked out to exactly this name. Applies before `starting_after`. required: false description: >- Only terminals checked out to exactly this name. Applies before `starting_after`. name: checked_out_to in: query responses: '200': description: A page of terminals content: application/json: schema: $ref: '#/components/schemas/TerminalList' '400': description: '`limit` out of range, or a filter or `starting_after` is malformed' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing, invalid or revoked API key content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: The API is not enabled for the workspace, or the key lacks the scope content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded; see Retry-After content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: [] components: schemas: TerminalList: type: object properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/Terminal' has_more: type: boolean required: - object - data - has_more Error: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - rate_limit_error - idempotency_error - card_error - api_error code: type: string message: type: string param: type: string request_id: type: string required: - type - code - message - request_id additionalProperties: type: string required: - error Terminal: type: object properties: object: type: string enum: - terminal id: type: string format: uuid example: 019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61 description: Pass it as `terminal` on a payment. label: type: - string - 'null' example: Truck 412 description: >- Your name for the terminal, such as the truck it rides in; null until you name it. model: type: - string - 'null' example: AMS1 serial_number: type: - string - 'null' example: '1853000123' description: Printed on the back of the terminal. checked_out_to: type: - string - 'null' example: Tablet TB0011 description: >- Who has the terminal right now, as you named them at check-out: a tablet, a truck, a driver. `null` while it sits free. checked_out_at: type: - string - 'null' format: date-time example: '2026-10-21T12:05:00.000Z' description: When it was checked out; `null` while it sits free. checked_out_by: type: - string - 'null' example: j.doe description: >- Your user who did the check-out, as you sent it; `null` when you sent none or while the terminal sits free. livemode: type: boolean example: false required: - object - id - label - model - serial_number - checked_out_to - checked_out_at - checked_out_by - livemode securitySchemes: bearerAuth: type: http scheme: bearer description: >- A secret key, `sk_test_...` or `sk_live_...`; a publishable key (`pk_...`) on the browser routes only ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.