Search user accounts

GET

/user/search

const url = 'https://example.com/user/search?uniqueId=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/user/search?uniqueId=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

uniqueId

required

string

Responses

200

Matching users returned.

application/json

Array<object>

The Abi record representing a person who can use a configured service.

object

required

The unique identifier Abi assigns to the user account.

string

uniqueId

An optional identifier from the partner system.

string

firstName

The user’s first name.

string

lastName

The user’s surname.

string

email

The user’s email address.

string format: email

phone

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

string

dateOfBirth

The user’s date of birth.

string

gender

The user’s gender where supplied.

string

Allowed values: male female other

language

required

The language used to communicate with Abi.

string

country

The user’s nationality or country code.

string

location

required

The country where the user lives or is currently located.

string

origin

required

The country in which the user was born.

string

physicianCountry

required

The country in which responding healthcare professionals are licensed.

string

partnerName

required

The partner company recorded in Abi.

string

associatedAccounts

The permitted number of associated accounts for an enabled group-account policy.

integer

userStatus

The user’s current access status.

string

Allowed values: activeUser pendingActivation deactivatedUser

Example

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