HTTP API (REST) Request URL shape {panel} {tenant} {resource} Example Authentication Where to go next

HTTP API (REST)

The REST API lets your organization integrate Hollowpurple with other tools, scripts, and custom interfaces. Making API requests (reading or writing data) requires a Pro or Enterprise subscription; Free and Starter organizations can still read the API documentation to plan integrations.

Request URL shape

Every resource URL follows this pattern:

 1https://hollowpurple.com/api/{panel}/{tenant}/{resource}

{panel} — always app

Use the literal segment app. That matches the main organization panel (the same product area as https://hollowpurple.com/app/...). Other panel IDs are not supported for your integration URLs.

{tenant} — your organization ID

{tenant} must be your organization’s tenant identifier — the same value that appears in the browser when you work in the main app.

  1. Log in and open the main app (/app).
  2. Look at the address bar. After /app/, the next path segment is your tenant ID (for example an ULID).
    • Example address: https://hollowpurple.com/app/01HZ…/customer-relations/leads
    • Your tenant ID for the API is: 01HZ… (that segment only).

Copy that value and use it as {tenant} in API calls. It must match the organization you have access to in the app.

{resource} — API route path

The rest of the path is the resource slug for the endpoint you need (for example categories, tags, stages). Available routes, methods, parameters, and schemas are listed in the interactive API docs.

Example

If your site is https://hpurple.test, panel is app, tenant ID is 01ABCDEFGHJKLMNPQRSTUVWX, and you’re calling the categories endpoint:

 1https://hpurple.test/api/app/01ABCDEFGHJKLMNPQRSTUVWX/categories

Replace the host and tenant ID with yours; use the exact paths shown in the API documentation for other resources.

Authentication

Create a personal API token under Settings → API tokens (outside the app panel, on your account settings). Send it as a Bearer token in the Authorization header. Your user must belong to the organization ({tenant}) you put in the URL.

Where to go next

  • API documentation — Full reference: endpoints, request bodies, responses, and authentication.
  • Plans & Billing — Upgrade to Pro or Enterprise if API access is not yet enabled for your organization.