Get started
Get started
Start with the public surface, which needs no account, then sign in for the full directory.
- Step 1
Search the public surface
Call GET /public/search?q=… on the API with no credentials. You get published users and groups, without their personal fields.
- Step 2
Sign in
Sign in with your Fleetworks account. The first sign-in creates your account with access pending until an admin grants you an Org role.
- Step 3
Look up the directory
With the org:contributor role or above, use the web app or call the LDAP Sync Cache lookups with your token.
- Step 4
Subscribe to changes
An admin registers a webhook endpoint. Verify the X-Rolodex-Signature header on each delivery.
What you need
- Nothing to search the public surface: any HTTP client works
- A Fleetworks account and an Org role granted by an admin to look up the whole directory
- A publicly reachable endpoint for webhooks: private addresses are refused