Skip to main content
GET
/
vendor
List vendors
curl --request GET \
  --url https://rest.staging.nickel.com/vendor \
  --header 'Authorization: Bearer <token>'
{
  "vendors": [
    {
      "id": "<string>",
      "name": "<string>",
      "emails": [
        "<string>"
      ],
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "type": "<string>",
      "vendorPayoutMethods": [
        {
          "id": "<string>",
          "type": "<string>",
          "routingNumber": "<string>",
          "accountType": "<string>",
          "bankName": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "swiftCode": "<string>",
          "iban": "<string>",
          "countryCode": "<string>"
        }
      ]
    }
  ],
  "totalResults": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

Page number for pagination

pageSize
integer

Number of results per page

vendorName
string

Filter vendors by name

Response

Successful operation

vendors
object[]
totalResults
integer