API response body

{
  "page": 1,
  "num_pages": 1,
  "users": [
    {
      "uuid": "17683027-18f6-418f-a79c-be7090be41fd",
      "first_name": "Hassan",
      "last_name": "Ali",
      "email": "hassan@pngme.demo.com",
      "device_id": "b53b4d4573b6c517",
      "external_id": null,
      "created_at": "2021-11-16T21:00:00+00:00",
      "updated_at": "2021-11-16T21:00:00+00:00",
      "phone_number": "2342345678904"
    },
    {
      "uuid": "59f361c8-9ea9-421b-aae5-c2d709f890ac",
      "first_name": "Muhammed",
      "last_name": "Aliyu",
      "email": "muhammed@pngme.demo.com",
      "device_id": "e53b0d4573b6c517",
      "external_id": null,
      "created_at": "2021-11-16T21:00:00+00:00",
      "updated_at": "2021-11-16T21:00:00+00:00",
      "phone_number": "2349012345678"
    },
    {
      "uuid": "c9f0624d-4e7a-41cc-964d-9ea3b268427f",
      "first_name": "Moses",
      "last_name": "Ali",
      "email": "moses@pngme.demo.com",
      "device_id": "a53b0d4573b6c517",
      "external_id": "003",
      "created_at": "2021-11-16T21:00:00+00:00",
      "updated_at": "2021-11-16T21:00:00+00:00",
      "phone_number": "254678901234"
    }
  ]
}

Summary

The /users API exposes tools to search and filter mobile phone users added by an organization's Android SDK.

Query/Response Behavior

If no time range is provided in the query, the endpoint defaults to returning a full page of users.

The ?search= query parameter can be used to find a user by first_name, last_name, email, primary_phone_number, external_id, or uuid. This can be used to fetch information about a user of interest, or identify the uuid necessary to access financial information about a user through other endpoints.

Fields

user[].uuid

A unique identifier for the user, used as the user_uuid path parameter for other endpoints, and provided by the Android SDK.

user[].first_name

The user's first name, provided by the Android SDK.

user[].last_name

The user's last name, provided by the Android SDK.

user[].email

The user's email address, provided by the Android SDK.

user[].phone_number

The user's phone number, provided by the Android SDK.

user[].device_id

Unique identifier of the user's mobile phone, provided by the Android SDK.

user[].external_id

External identifier configured while integrating the Android SDK. Can be used to identify users in other identity systems.

user[].created_at

Date and time when the user was first provisioned in the Pngme system.

user[].updated_at

Date and time when the user was last updated in the Pngme system.