Get a Customer or Supplier by ID

Retrieves a customer or supplier by its unique ID or user-generated customer or supplier ID.

View as Markdown

GET /v1/business-entities/{id}

Needs an API key with the read scope.

Path parameters

id string Required

Returns

The customer or supplier.

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/{id}

curl https://api.nuvio.io/v1/business-entities/7c9e6679-7425-40de-944b-e07fc1f90ae7 \
  -H "Authorization: Bearer $NUVIO_API_TOKEN"

const response = await fetch('https://api.nuvio.io/v1/business-entities/7c9e6679-7425-40de-944b-e07fc1f90ae7', {
  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/7c9e6679-7425-40de-944b-e07fc1f90ae7",
    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
  }
}