Search user accounts

GET

/user/search

curl --request GET \
  --url 'https://client-api.abi.ai/user/search?email=janedoe%40example.com&phone=%2B441234567890&uniqueId=123abc789xyz&userStatus=activeUser' \
  --header 'Authorization: Bearer <token>'

• Abi Client API

Send one or more of the query parameters below. Each parameter is optional on its own, but every request must include at least one search criterion.

Authorizations

• bearerAuth

Parameters

Query Parameters

email

string format: email

The user’s email address.

Example

janedoe@example.com

phone

string

The user’s mobile number including international dialing code (E.164).

Example

+441234567890

uniqueId

string

Your stable identifier for the user.

Example

123abc789xyz

userStatus

string

Allowed values: activeUser deactivatedUser pendingActivation

Limit the search to an account status.

Example

activeUser

Responses

200

Matching user returned. See the User account model for the full response-field reference.

Media typeapplication/json

object

Example

{
  "id": "abi1234",
  "uniqueId": "123abc789xyz",
  "userStatus": "activeUser",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "janedoe@gmail.com",
  "gender": "female",
  "phone": "+441234567890",
  "origin": "gb",
  "location": "es",
  "country": "it",
  "physicianCountry": "es",
  "language": "en",
  "dateOfBirth": "1994-10-07",
  "partnerName": "Abi",
  "associatedAccounts": 5
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}