Clients

List clients

Every client on the account - the companies your suppliers and buyers belong to.

Paged with a cursor: pass the response's search_after value for the next page.

The cursor is opaque in this version - echo it back unchanged. v1 publishes a raw client id here instead.

To find one client, filter by email or phone. Both are exact matches against the value as stored - phone=5557582870, not a part of it. Given together, a client has to match both.

get/v2/clients

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/v2/clients
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Query parameters

emailstring

An email address, matched exactly.

phonestring

A phone number, exactly as stored.

search_afterstring

The search_after value from the previous page. Omit for the first page.

include_deletedboolean

Include clients that have been deleted.

Response

Success

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.