The public directory API (find a provider)

Read-only, no-key endpoints that list providers with a live paid directory listing, for websites and landing pages.

1 min readLast updated

Applies to: Free: no pack needed · Visitors and anyone with a link, Providers

On this page

The public directory API is what the iComply website uses for its find-a-provider pages. Anyone can read it, with no key. It shows only providers with a live paid listing (Listed, Preferred or Partner) and founding partners iComply lists itself. Free profiles never appear.

The endpoints

  • GET /api/public/providers: search, 20 a page, ranked as in the app. Filter with category, region (a state code such as VIC), q (up to 120 characters; every word must match) and page.
  • GET /api/public/providers/<slug>: one listing in full: services, regions, programs, availability, approved reviews (authors shown only as, for example, an organisation type and state), and the organisations that agreed to be named. Each call counts one profile view.
  • GET /api/public/providers/featured: up to 6 featured Partners for a category and region, topped up with iComply Preferred badge holders.
  • GET /api/public/providers/<slug>/photo/<n>: a listing's photo (counting from 0).

What's never included

  • Compliance documents, approvals or any organisation's decisions.
  • Email addresses, phone numbers, ABNs, invoices or internal ids.
  • Reviewers' names, unmoderated or private comments, or clients who didn't agree to be named.

Limits

  • 300 requests a minute per connection; past it, 429 with Retry-After.
  • Answers are cached for 5 minutes, so a paused, lapsed or hidden listing disappears within 5 minutes.
  • Unknown, free, paused, lapsed or hidden listings answer 404. Bad filter values are ignored.
For providers: how you appear depends on your directory plan. See Directory plans.
Was this helpful?

Related articles