Skip to content
Chorus
Menu

Get started

Get started

Start with the public directory, which needs no account, then sign in to manage your organization’s records.

  1. Step 1

    Search the public directory

    Call GET /public/search?q=… on the API with no credentials. You get published records only, through a strict field allowlist.

  2. Step 2

    Sign in

    Sign in with your Fleetworks account. Your first sign-in creates your user; access stays pending until an org:admin grants you a role.

  3. Step 3

    Manage records

    With the org:contributor role or above, create and edit records in the dashboard, or call the API with your token.

  4. Step 4

    Subscribe to changes

    An org:admin registers a webhook. Verify the X-DNS-Signature header on each delivery with the webhook’s signing secret.

What you need

  • Nothing to search the public directory: any HTTP client works
  • A Fleetworks account and a role in an organization, granted by an org:admin, to manage records
  • A publicly reachable HTTPS endpoint for webhooks: private addresses are refused