GET /v1/terminal/readers

Returns a list of Reader objects.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
device_type String No

Filters readers by device type

Possible values:

  • "stripe_s700"
  • "bbpos_wisepos_e"
  • "mobile_phone_reader"
  • "stripe_m2"
  • "bbpos_wisepad3"
  • "simulated_stripe_s700"
  • "simulated_wisepos_e"
  • "bbpos_chipper2x"
  • "verifone_P400"
limit Integer No

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

location String No

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

starting_after String No

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.

serial_number String No

Filters readers by serial number

expand[] Array No

Specifies which fields in the response should be expanded.

ending_before String No

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.

status String No

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

Possible values:

  • "offline"
  • "online"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.