---
title: "Export users"
method: GET
path: "/v3/user-export"
tags: ["User Export"]
---

# Export users

`GET /v3/user-export`

Export users who match the provided parameters.

## Query parameters

- `attributes` boolean, required
- `appIds` string, required
- `appIdsRestrictive` boolean
- `grants` boolean
- `since` string
- `registeredSince` string
- `registeredBefore` string
- `rpp` number
- `page` number

## Response `200`

OK - The paginated user data has been exported successfully.

- UserExportPaginatedResponse
  - `results` UserExportResponseItems[]
    - UserExportResponseItem[]
      - `seq-no` number
      - `user` UserExportUser, required
        - `identifiers` Identifiers, required
          - `email_address` string
        - `attributes` Attributes
          - `first_name` string
          - `surname` string
      - `grants` GrantsResponse
        - `results` GrantResponse[]
          - `grantId` string
          - `user_id` string
          - `account_id` string
          - `expiry_state` 'pending' | 'active' | 'expired'
          - `entitlement_type` 'bundle' | 'entitlement' | 'meter' | 'credits' — An enum describing the type of the entitlement.
          - `entitlement_id` string
          - `startTime` string
          - `endTime` string
          - `product_id` string
          - `createdAt` string
  - `meta` object
    - `count` number
    - `rpp` number
    - `paginated` boolean
  - `links` object
    - `first` PaginationLink
      - `url` string — The link's url
      - `page` number — The page number the link is pointing to
    - `last` PaginationLink
      - `url` string — The link's url
      - `page` number — The page number the link is pointing to
    - `previous` PaginationLink
      - `url` string — The link's url
      - `page` number — The page number the link is pointing to
    - `next` PaginationLink
      - `url` string — The link's url
      - `page` number — The page number the link is pointing to

---

[API](https://skmtc.net/zuora/apis/admin-api-reference.md) · [All operations](https://skmtc.net/zuora/apis/admin-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zuora/admin-api-reference/revisions/789812d35ac8/schema)