List all Customers or Suppliers

Retrieves all the customers or suppliers that match with provided filters

View as Markdown

GET /v1/business-entities

Needs an API key with the read scope.

Query parameters

isSupplier string

Send this as true if you would like to list suppliers.
isCustomer string

Send this as true if you would like to list customers.

Returns

The matching customers and suppliers.

401: No usable Authorization: Bearer {token} header (1002).
403: The access token is unknown, or lacks the scope this route needs (1001).

GET /v1/business-entities

curl https://api.nuvio.io/v1/business-entities \
  -H "Authorization: Bearer $NUVIO_API_TOKEN"

const response = await fetch('https://api.nuvio.io/v1/business-entities', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.NUVIO_API_TOKEN}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://api.nuvio.io/v1/business-entities",
    headers={"Authorization": f"Bearer {os.environ['NUVIO_API_TOKEN']}"},
)
data = response.json()["data"]

Response

{
  "success": true,
  "errors": null,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "entityCode": "ACME-01",
      "name": "Acme Supplies",
      "legalName": "Acme Supplies",
      "vatNumber": "INV-2026-0042",
      "taxOffice": "string",
      "address": "100 Main Street",
      "city": "Toronto",
      "country": "string",
      "district": "string",
      "state": "string",
      "postalCode": "ACME-01",
      "email": "billing@example.com",
      "phone": "+1 555 0100",
      "iban": "string",
      "isCustomer": true,
      "isSupplier": true
    }
  ]
}