Search for users

Supports full match search by email and/or phone number. This means you can search for records using either an email address or a phone number, but the search will only return results that exactly match the provided email address or phone number.

Use this endpoint to check if a user with the given email/phone already exists. If you need to get more data about a user, call GET /v1/users/{User-ID} endpoint.

For Partners, using BTS “Bring Your Own License” solution, this endpoint is restricted.

SecuritybearerAuth
Request
query Parameters
email
string

Email of user

Example: email=john.doe@domain.com
phone
string

User's phone number

Example: phone=38712345678
page_size
integer

Number of elements to be displayed on a page

Example: page_size=10
page
integer

Display page number

Example: page=1
Responses
200

List users that match the search query parameters

401

Unauthorized

422

Error

429

Too Many Requests

500

Error

503

Maintenance or Service unavailable

get/v1/users
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}