Search user accounts

POST

/user/search

curl --request POST \
  --url https://client-api.abi.ai/user/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "uniqueId": "123abc789xyz" }'

• Abi Client API

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

Supply one or more search fields. At least one field is required.

object

>= 1 properties

uniqueId

Your stable identifier for the user.

string

Example

123abc789xyz

email

The user’s email address.

string format: email

Example

janedoe@example.com

phone

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

string

Example

+441234567890

userStatus

The account status to match.

string

Allowed values: activeUser deactivatedUser pendingActivation

Example

activeUser

Example

{
  "uniqueId": "123abc789xyz"
}

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"
}