Skip to content
Yellow Pages
Menu

Get started

Get started

Start reading without an account, then sign in when you need to write.

  1. Step 1

    Read public rows

    Call GET /api/service on the API with no credentials. You get every Service whose Mode lets everyone view it.

  2. Step 2

    Sign in

    Sign in with your Fleetworks account to see the rows you own or your group can view, and to edit them.

  3. Step 3

    Issue an API key

    In Settings → Integrations, create a key with read or write scope. It is shown once as yp_…; store it then.

  4. Step 4

    Subscribe to changes

    Register a public HTTPS webhook and verify the X-YP-Signature header on each delivery.

What you need

  • Nothing to read public rows: any HTTP client works
  • A Fleetworks account to sign in and write; sign-up is limited by an allowlist an admin controls
  • A public HTTPS endpoint for webhooks: private addresses are refused