Skip to content
Zulu

API reference

Your business

Read your business's details, logo, plan and usage, team, roles and activity log.

Read-only information about the business the key belongs to. Changing the business, its team, roles or API keys needs a person logged in to Zulu, so keys can't do it.

Business details

Get the current business

GET/v1/business

Use GET /me to list all of your businesses.

Needs the business:read permission

Request
curl https://api.zulu.ie/v1/business \
  -H "Authorization: Bearer $ZULU_API_KEY" \
  -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"
Example response200
Response · 200
{
  "id": "business_2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
  "created_at": "2026-10-27T09:30:00.000Z",
  "updated_at": "2026-10-27T09:30:00.000Z",
  "name": "Main",
  "vat_number": "IE9876543W",
  "email": [
    {
      "id": "email_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "created_at": "2026-10-27T09:30:00.000Z",
      "updated_at": "2026-10-27T09:30:00.000Z",
      "contact_id": "contact_8a3e2c1d-4b5f-4e6a-9c7d-1e2f3a4b5c6d",
      "name": "Main",
      "email": "accounts@globex.ie",
      "first_name": "Aoife",
      "last_name": "Murphy",
      "is_primary": true
    }
  ],
  "phone": [
    {
      "id": "phone_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "created_at": "2026-10-27T09:30:00.000Z",
      "updated_at": "2026-10-27T09:30:00.000Z",
      "contact_id": "contact_8a3e2c1d-4b5f-4e6a-9c7d-1e2f3a4b5c6d",
      "name": "Main",
      "phone": "+353 1 234 5678",
      "is_primary": true
    }
  ],
  "address": [
    {
      "id": "address_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "created_at": "2026-10-27T09:30:00.000Z",
      "updated_at": "2026-10-27T09:30:00.000Z",
      "contact_id": "contact_8a3e2c1d-4b5f-4e6a-9c7d-1e2f3a4b5c6d",
      "name": "Main",
      "address_1": "Unit 4, Docklands Innovation Park",
      "address_2": null,
      "city": "Dublin 1",
      "county": "Dublin",
      "eircode": "D01 X2Y3",
      "country": "Ireland",
      "is_primary": true
    }
  ]
}

Plan and usage

Get the business's plan, its limits and current usage

GET/v1/business/plan

Needs the business:read permission

Request
curl https://api.zulu.ie/v1/business/plan \
  -H "Authorization: Bearer $ZULU_API_KEY" \
  -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"
Example response200
Response · 200
{
  "plan": "free",
  "status": "trialing",
  "started_at": "2026-10-27T09:30:00.000Z",
  "trial_ends_at": "2026-10-27T09:30:00.000Z",
  "limits": {
    "users": 1,
    "invoices_per_month": 1,
    "contacts": 1,
    "catalog_items": 1,
    "recipients_per_day": 1,
    "recipients_per_month": 1
  },
  "features": [
    "scheduling"
  ],
  "usage": {
    "users": 1,
    "invoices_this_month": 1,
    "contacts": 1,
    "catalog_items": 1,
    "recipients_today": 1,
    "recipients_this_month": 1
  },
  "billing": {
    "interval": "month",
    "current_period_ends_at": "2026-10-27T09:30:00.000Z",
    "cancel_at_period_end": false,
    "scheduled_change": {
      "plan": "pro",
      "interval": "month"
    },
    "pending_change": {
      "plan": "pro",
      "interval": "month",
      "expires_at": "2026-10-27T09:30:00.000Z"
    },
    "trial_ends_at": "2026-10-27T09:30:00.000Z"
  }
}

Team members

List members, or get one by id

GET/v1/business/member

query searches name and email.

Needs the business:read permission

Query parameters

  • idmembership id

    membership_

  • querytext

    Up to 200 characters

  • limitnumber

    1–50, default 20

  • aftermembership id

    membership_

  • beforemembership id

    membership_

Request
curl https://api.zulu.ie/v1/business/member \
  -H "Authorization: Bearer $ZULU_API_KEY" \
  -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"
Example response200
Response · 200
{
  "data": [
    {
      "id": "membership_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "created_at": "2026-10-27T09:30:00.000Z",
      "updated_at": "2026-10-27T09:30:00.000Z",
      "user": {
        "id": "user_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
        "email": "accounts@globex.ie",
        "name": "Main"
      },
      "role": {
        "id": "role_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
        "name": "Main"
      }
    }
  ],
  "has_more": false
}

Roles

List the business's roles

GET/v1/business/role

The built-in roles (owner, admin, user) and the business's custom roles. All of them, without paging.

Needs the business:read permission

Request
curl https://api.zulu.ie/v1/business/role \
  -H "Authorization: Bearer $ZULU_API_KEY" \
  -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"
Example response200
Response · 200
{
  "data": [
    {
      "id": "role_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "created_at": "2026-10-27T09:30:00.000Z",
      "updated_at": "2026-10-27T09:30:00.000Z",
      "name": "Main",
      "permissions": [
        "business:read"
      ],
      "is_system": false
    }
  ],
  "has_more": false
}

Audit log

List the business's audit log, newest first

GET/v1/business/audit-event

Scale plan only. Filter by action or target_id; query searches actions.

Needs the audit_log:read permission

Query parameters

  • idaudit event id

    audit_event_

  • querytext

    Up to 200 characters

  • limitnumber

    1–50, default 20

  • afteraudit event id

    audit_event_

  • beforeaudit event id

    audit_event_

  • category"invoices" | "customers" | "emails" | "access"

    invoices (invoice.), customers (contact.), emails (email.*), or access (members, invites, roles, API keys, the business and its plan)

  • actiontext

    Up to 100 characters

  • target_idtext

    Up to 100 characters

Request
curl https://api.zulu.ie/v1/business/audit-event \
  -H "Authorization: Bearer $ZULU_API_KEY" \
  -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"
Example response200
Response · 200
{
  "data": [
    {
      "id": "audit_event_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "created_at": "2026-10-27T09:30:00.000Z",
      "action": "invoice.sent",
      "actor_user_id": "user_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "actor_api_key_id": "api_key_3f2b8c1e-7a6d-4e5f-9b0a-1c2d3e4f5a6b",
      "target_id": "…",
      "data": "…"
    }
  ],
  "has_more": false
}
PreviousExport