List all Readers

Changed on

Returns a list of Reader objects.

get/v1/terminal/readers

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/terminal/readers
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

device_type'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' | 'mobile_phone_reader' | 'simulated_stripe_s700' | 'simulated_stripe_s710' | 'simulated_verifone_m425' | 'simulated_verifone_p630' | 'simulated_verifone_ux700' | 'simulated_verifone_v660p' | 'simulated_wisepos_e' | 'stripe_m2' | 'stripe_s700' | 'stripe_s710' | 'verifone_P400' | 'verifone_m425' | 'verifone_p630' | 'verifone_ux700' | 'verifone_v660p'

Filters readers by device type

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

locationstring

A location ID to filter the response list to only readers at the specific location

serial_numberstring

Filters readers by serial number

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

status'offline' | 'online'

A status filter to filter readers to only offline or online readers

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.

Changes

  • 9d681f6248d7Revision changes
    • warning

      added the new simulated_stripe_s710 enum value to the // response property for the response status

    • warning

      added the new stripe_s710 enum value to the // response property for the response status

    • info

      added the new enum value simulated_stripe_s710 to the query request parameter device_type

    • info

      added the new enum value stripe_s710 to the query request parameter device_type

Some revisions have not been checked yet.