v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Businesses

List businesses

List all businesses. Supports filtering by book_id, name, and updated_since.

get/v1/businesses

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

book_idstring

Filter by book ID

namestring

Filter by business name (prefix/full-text match, not arbitrary substring)

updated_sincestring

Filter by last updated datetime (ISO8601)

Response

successful

Example response

{
  "data": [
    {
      "id": "abc123xyz",
      "book_id": "book123xyz",
      "name": "Acme Corp",
      "industry": "Technology",
      "website_url": "https://acme.com",
      "tax_id": "12-3456789",
      "email_addresses": [
        {
          "email": "john.doe@example.com",
          "email_type": "personal",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "+15555551234",
          "extension": "1234",
          "phone_type": "mobile",
          "is_primary": true
        }
      ],
      "addresses": [
        {
          "line1": "123 Main St",
          "line2": "Apt 4B",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country_code": "US",
          "address_type": "home",
          "is_primary": true
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}