List all clients

get

https://api.thelookoutapp.com/api/{company_id}/clients

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

The page number to retrieve (default is 1). Read more

per

integer

The number of items per page (default is 25). Read more

custom attributes filter

object

The key corresponds to the custom attribute key defined in Lookout. Read more

object

Search items by email or full_name. Read more

created_at

object

Filter by created_at value. Read more

updated_at

object

Filter by updated_at value. Read more

archive_reason

object

Filter by archive_reason value. Read more

archived_at

object

Filter by archived_at value. Read more

commenced_on

object

Filter by commenced_on value. Read more

signed_up_on

object

Filter by signed_up_on value. Read more

next_review_on

object

Filter by next_review_on value. Read more

community_id

object

Filter by community_id value. Read more

plan_id

object

Filter by plan_id value. Read more

funding_scheme

object

Filter by funding_scheme value. Read more

archived

boolean

Filter by archived value. Read more

object

Filter by email value. Read more

telephone

string

Filter by telephone value. Read more

primary_member_profile_id

object

Filter by primary_member_profile_id value. Read more

Response

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200Clients found with primary_member_profile_id filter