Search Users

GET {{baseUrl}}/users?filter=first_name:eq:Greg&filter=last_name:eq:Benson

Request Params

KeyDatatypeRequiredDescription
user_idstring
filterstringoperators - eq, begins, contains, in
filterstringoperators - eq, begins, contains
filterstringoperators - eq, begins, contains
filterstringoperators - eq, in
filterstringoperators - eq, begins, contains
filterstringoperators - lt, lte, gt, gte, between
limitnumber
orderstring
order_bystring
nextstring

RESPONSES

status: OK

{"count":3,"next":"","users":[{"id":"@greg","first_name":"Greg","last_name":"Benson","avatar_url":"https://i.pravatar.cc/150?u=548754bf-fe38-4501-9679-bc242ac40bc7","metadata":"email=greg@companyname.com,phone=+15551234567","state":"active","created_at":"2023-10-05T08:45:10.729Z","updated_at":"2023-10-05T08:45:10.729Z","presence":{"connected":false,"state":"","status":"","last_active_at":""},"blocked":null},{"id":"1234567","first_name":"Greg","last_name":"Benson","avatar_url":"","metadata":"email=greg@companyname.com,phone=+15551234567","state":"active","created_at":"2023-09-11T12:15:38.560Z","updated_at":"2023-09-11T12:18:36.863Z","presence":{"connected":false,"state":"","status":"","last_active_at":""},"blocked":null},{"id":"benson","first_name":"Greg","last_name":"Benson","avatar_url":"https://i.pravatar.cc/150?u=548754bf-fe38-4501-9679-bc242ac40bc7","metadata":"email=greg@companyname.com,phone=+15551234567","state":"active","created_at":"2023-06-28T13:34:52.908Z","updated_at":"2023-06-28T13:34:52.908Z","presence":{"connected":false,"state":"","status":"","last_active_at":""},"blocked":null}]}