Skip to main content

Get a list of users

You can call the API to get a list of all users who have signed in to your project at least one time.

User information is also available on your Dashboard > Data > Users.

Prerequisites

You need a project access token to call the query.

Guide​

  1. Call the users query.
  2. Add all information you'd like to review. The sample query gathers almost all information available when calling this query.
  3. If you want to know when the user provided their first OAuth 2.0 consent, include the joinedAt attribute.
  4. Consider adding pagination if you're expecting a long list.

Query​

🔎 Open the query in API Explorer

query GetUsersList {
  users {
    edges {
      node {
        id
        joinedAt
        lastName
        mobilePhoneNumber
        nationalityCCA3
        preferredNotificationChannel
        updatedAt
        identificationLevels {
          expert
          QES
          PVID
        }
        firstName
        createdAt
        birthDate
        authenticators {
          acceptLanguage
          brand
          type
          userAgent
          os
          model
        }
        verifiedEmails
      }
    }
    totalCount
  }
}

Payload​

In the payload, note the IDs, name information, mobile number, the true or false for each identification level, and more. Because it was added in the query, you also know when each user joined your project (line 8).

{
  "data": {
    "users": {
      "edges": [
        {
          "node": {
            "id": "$USER_1_ID",
            "joinedAt": "2024-01-18T13:42:50.106Z",
            "lastName": "Ngoma",
            "mobilePhoneNumber": "$MOBILE_NUMBER",
            "nationalityCCA3": "FRA",
            "preferredNotificationChannel": null,
            "updatedAt": "2024-01-25T15:26:25.829Z",
            "identificationLevels": {
              "expert": true,
              "QES": false,
              "PVID": false
            },
            "firstName": "Malika",
            "createdAt": "2024-01-17T15:14:01.480Z",
            "birthDate": "1986-12-11",
            "authenticators": [
              {
                "acceptLanguage": "en",
                "brand": "Apple",
                "type": "SwanWeb",
                "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_2_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Mobile/15E148 Safari/604.1",
                "os": "iOS",
                "model": "iPhone"
              }
            ],
            "verifiedEmails": [malika@mybrand.io]
          }
        },
        {
          "node": {
            "id": "$USER_2_ID",
            "joinedAt": "2024-01-18T13:44:22.504Z",
            "lastName": "Byrne",
            "mobilePhoneNumber": "$MOBILE_NUMBER",
            "nationalityCCA3": "IRL",
            "preferredNotificationChannel": null,
            "updatedAt": "2024-01-21T15:00:37.810Z",
            "identificationLevels": {
              "expert": true,
              "QES": true,
              "PVID": true
            },
            "firstName": "Dillon",
            "createdAt": "2024-01-02T17:28:03.935Z",
            "birthDate": "1990-09-24",
            "authenticators": [
              {
                "acceptLanguage": "en",
                "brand": "Apple",
                "type": "SwanWeb",
                "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_2_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Mobile/15E148 Safari/604.1",
                "os": "iOS",
                "model": "iPhone"
              }
            ],
            "verifiedEmails": []
          }
        },
        {
          "node": {
            "id": "$USER_3_ID",
            "joinedAt": "2023-06-20T12:54:59.855Z",
            "lastName": "Fleury",
            "mobilePhoneNumber": "$MOBILE_NUMBER",
            "nationalityCCA3": "FRA",
            "preferredNotificationChannel": "Sms",
            "updatedAt": "2024-01-24T20:01:54.388Z",
            "identificationLevels": {
              "expert": false,
              "QES": false,
              "PVID": false
            },
            "firstName": "Jules",
            "createdAt": "2023-03-30T13:08:55.578Z",
            "birthDate": "1988-08-06",
            "authenticators": [
              {
                "acceptLanguage": "en",
                "brand": "Apple",
                "type": "SwanWeb",
                "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_2_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Mobile/15E148 Safari/604.1",
                "os": "iOS",
                "model": "iPhone"
              }
            ],
            "verifiedEmails": []
          }
        },
      ],
      "totalCount": 3
    }
  }
}