OCocrolus
Business history

Business identifier

This API retrieves the business associated with a given book_uuid. It returns the business ID and display name, which can be used with business-level endpoints to access aggregated data across multiple <glossary:Book>s. A single business can have multiple Books. All books associated with the same business within your organization return the same business ID.

get/v2/book/{book_uuid}/business

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v2/book/{book_uuid}/business
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

book_uuidstring uuid required
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

A universally unique identifier (UUID) of the Book used to retrieve its associated business.

Response

Success

idstring

Universally Unique Identifier (UUID) of the business entity. This is a stable identifier that is used with all business endpoints.

namestring

Display name of the business. The name is determined in the following order: user-defined display name, org-specific name, then global entity name.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Acme Corp"
}

Changes

No recorded changes to this operation across all 1 revision of this API.