Filter Users by Email

POST 
/users/search/filter-by-email

Filter users by company ID, deleted status, and email array

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

companyIdstringrequired

Company ID to filter users

emailsstringrequired

Comma-separated list of email addresses to filter users

deletedboolean
Filter deleted users
Default value: false
skipstring
No of results to be skipped before returning the result
Default value: 0
limitstring
No of results to be limited before returning the result
Default value: 25
projectionstring

Projection fields to return. Use "all" for all fields, or specify comma-separated field names. Default returns only id and email

Example (auto)

{
  "companyId": "5DP41231LkQsiKESj6rh",
  "emails": "[email protected],[email protected]",
  "deleted": false,
  "skip": "1",
  "limit": "10",
  "projection": "all"
}

application/json

Successful response

application/json

Schema

Schema

usersobject[]

List of users matching the search criteria

countnumber

Total number of users matching the search criteria

Example (auto)

{
  "users": [
    {
      "id": "0IHuJvc2ofPAAA8GzTRi",
      "firstName": "John",
      "lastName": "Deo",
      "email": "[email protected]"
    }
  ],
  "count": 1231
}