List

Fetch all businesses

GET /v1/platform/businesses

List

cURL

curl --request GET \
  --url https://api.cadanapay.com/v1/platform/businesses \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "name": "Wayne Enterprise",
      "shortName": "W.E.",
      "status": "active",
      "tenantKey": "abc123",
      "country": "US",
      "address": {
        "countryCode": "US",
        "line1": "Street 1",
        "line2": "Apt 1",
        "city": "Gotham",
        "postalCode": "10001",
        "state": "NY"
      }
    }
  ],
  "node": {
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

idempotencyKey · string

Idempotency key of a business

next · string

Query next set of results based on limit

previous · string

Query previous set of results based on limit

limit · integer · default: 20

Maximum number of items to return per page

Required range: 1 <= x <= 100

Response

200

application/json

get businesses response

data · object[]

Show child attributes

node · object

Node pagination

Show child attributes