Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
User Export

Export users

Export users who match the provided parameters.

get/v3/user-export

Query parameters

attributesboolean required

Whether or not to include core attributes.

appIdsstring required

Comma-delimited list of appIds to retrieve extended profile data for. If appIds is present and attributes isn't, only users with matching extended profiles will be returned.

appIdsRestrictiveboolean

Only include users with a matching extended profile

grantsboolean

Include information about entitlements

sincestring

Users who were updated after the specified date

registeredSincestring

Users who have registered after the specified date

registeredBeforestring

Users who have registered before the specified date

rppnumber

Results per page

pagenumber

The requested page of results

Response

OK - The paginated user data has been exported successfully.

Example response

{
  "results": [
    [
      {
        "seq-no": 1,
        "user": {
          "identifiers": {
            "email_address": "joe.blow@company.com"
          },
          "attributes": {
            "first_name": "Joe",
            "surname": "Blow"
          }
        },
        "grants": {
          "results": [
            {
              "grantId": "e196ad75-a6d0-471b-90b3-de3843dd7860",
              "user_id": "e1812285-2f21-441e-8be4-b08835cd4b2c",
              "account_id": "14515649-565f-4b1c-8346-eb98301c1d6b",
              "entitlement_id": "b74df5c4-fded-492c-ad90-07646bded5db",
              "startTime": "2022-06-01 00:00:00",
              "endTime": "2022-12-31 23:59:59",
              "product_id": "86abb44a-e6f2-4f9b-ac26-46ae0a13ed31",
              "createdAt": "2022-05-31 23:59:59"
            }
          ]
        }
      }
    ]
  ],
  "meta": {
    "count": 100,
    "rpp": 20,
    "paginated": true
  },
  "links": {
    "first": {
      "url": "https://example.com?rpp=10",
      "page": 1
    },
    "last": {
      "url": "https://example.com?rpp=10",
      "page": 1
    },
    "previous": {
      "url": "https://example.com?rpp=10",
      "page": 1
    },
    "next": {
      "url": "https://example.com?rpp=10",
      "page": 1
    }
  }
}