Filter clients

get

https://api.repliers.io/clients

Use this endpoint to get a list of clients that you've created. You can filter for specific clients using parameters like email address and first name. If you don't use any filters all clients will be returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

agentId

int32

clientId

int32

string

fname

string

keywords

string

One or more keywords may be specified to filter the results by. Useful for searching clients. If specified all other params are ignored.

lname

string

phone

int32

status

boolean

condition

string

Defaults to EXACT

Determines the search condition applied to the filters. If EXACT, requires that the given value for one or more params is an exact match of the stored value. If CONTAINS, requires that the given value for one or more params is contained within the stored value.

Allowed values:

EXACT, CONTAINS

operator

string

Defaults to OR

Determines the search logic applied to the filters. If OR, requires that one or more params contain/equal the given value. If AND, requires that all params contain/equal the given value.

Allowed values:

OR, AND

pageNum

int32

Defaults to 1

If specified indexes a specific page in the results set. For example, if there are 1000 listings and 100 listings per page, if you'd like to view listings 101-201 you'd specify pageNum=2

resultsPerPage

int32

Defaults to 100

The amount of listings to return in each page of the results set.

tags

string

One or more comma separated strings that can be used to filter clients. For example GET /clients?tags=buyer,toronto. The response contains clients that have any of the tags specified.

showSavedSearches

boolean

Defaults to true

Enables automatic retrieval of Saved Searches for each client in the response. For best performance it's recommended to disable this setting if Saved Searches are not required.

externalId

string

Filter clients by their identifier from an external system (such as a CRM).

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Bad Request