Skip to content
/User Export

Admin API Reference (2026-01-08)

The Zephr Admin API provides RESTful access to all Zephr functionality. It is designed for server-side integrations. All requests must be signed as described in HMAC Request Signing and Key Pairs.

The Admin API uses a base URL with the following format: https://{tenantId}.api.zephr.com

Note: If you have multiple tenants, the current tenant ID is shown in a blue box in the top right of the Admin Console. If you have a single site, you can find the tenant ID by navigating to your site domains. To do this, select Sites from the Delivery menu, select your site, and then click the Site Domains button. The tenant ID is the first part of the domain. For example, if the domain is news-paper.cdn.zephr.com, the tenant ID is news.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api
https://{tenantId}.api.zephr.com

Account User

Contains operations on the Account User resource.

Operations

Admin User

Contains operations on the Admin User resource.

Operations

Bundle

Contains operations on the Bundle resource.

Operations

Cache Configurations

Contains operations on the Cache Configurations resource.

Operations

Cache Management

Cache Mangement.

Operations

Company

Actions on resource Company.

Operations

Component Library

Actions on resource Library Component.

Operations

Configuration

Blaize tenant configuration.

Operations

Credit

Actions on resource Credit.

Operations

Decision Engine

Operations

Email Templates

Actions on email templates.

Operations

Entitlement

Actions on resource Entitlement.

Operations

Feature Rules

Actions on resource Feature Rules.

Note: - Note: The APIs mentioned in this section support legacy Feature Rules only. Feature Rules created through the Admin Console (V4 Features) are stored in a different system and are not accessible through these APIs.

Operations

Form

Actions on resource Form.

Operations

Gifts

Operations

Grants

Actions on resource Grant.

Operations

Meter

Actions on resource Meter.

Operations

Products

Actions on resource Product.

Operations

Request Rules

Actions on resource Request Rules.

Operations

Session

Actions on resource Session.

Operations

Static Items

Actions on resource Static Item.

Operations

Third Party Authentication

Contains operations for the OAuth 2.0 Authorization Code Flow Token Exchange.

Operations

User Export

Operations

Export users

Request

Export users who match the provided parameters.

Security
ZephrHmacHttp
Query
attributesbooleanrequired

Whether or not to include core attributes.

Example: attributes=true
appIdsstringrequired

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.

Example: appIds=quiz1,survey4
appIdsRestrictiveboolean

Only include users with a matching extended profile

Example: appIdsRestrictive=true
grantsboolean

Include information about entitlements

Example: grants=true
sincestring

Users who were updated after the specified date

Example: since=2020-01-01T00:00:00Z
registeredSincestring

Users who have registered after the specified date

Example: registeredSince=2020-01-01T00:00:00Z
registeredBeforestring

Users who have registered before the specified date

Example: registeredBefore=2020-01-01T00:00:00Z
rppnumber

Results per page

Default 500
Example: rpp=40
pagenumber

The requested page of results

Default 1
Example: page=1
curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/user-export?attributes=true&appIds=quiz1%2Csurvey4&appIdsRestrictive=true&grants=true&since=2020-01-01T00%3A00%3A00Z&registeredSince=2020-01-01T00%3A00%3A00Z&registeredBefore=2020-01-01T00%3A00%3A00Z&rpp=40&page=1' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - The paginated user data has been exported successfully.

Bodyapplication/json
resultsArray of objects(user-export-response-items)
metaobject
linksobject
Response
application/json
{
  "results": [
    [ … ]
  ],
  "meta": {
    "count": 100,
    "rpp": 20,
    "paginated": true
  },
  "links": {
    "first": { … },
    "last": { … },
    "previous": { … },
    "next": { … }
  }
}

Export users and user events

Request

Downloads all subscribers and subscriber events data in csv format.

  • To download subscribers data, specify the attributes query parameter to true, and use the attr, appIds, appIdsRestrictive, grants, since, registeredSince, registeredBefore, foreignKeys query parameters.
  • To download subscriber events data, specify the eventsExport query parameter to true, and use the from and to query parameters.
  • For pagination, use the rpp and page query parameters
Security
ZephrHmacHttp
Query
attributesboolean

Whether or not to include core attributes

Example: attributes=true
attrstring

Comma-delimited list of user attribute filters in the following format: attributeKey.operation.value or attributeKey.operation.value1.value2.

Example: attr=attr1.contains.a,attr2.equals.3
appIdsstring

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. Use all to retrieve all extended profile data.

Example: appIds=quiz1,survey4,all
appIdsRestrictiveboolean

Only include users with a matching extended profile

Example: appIdsRestrictive=true
grantsboolean

Include information about entitlements

Example: grants=true
sincestring

Users who were updated after the specified date

Example: since=2020-01-01T00:00:00Z
registeredSincestring

Users who have registered after the specified date

Example: registeredSince=2020-01-01T00:00:00Z
registeredBeforestring

Users who have registered before the specified date

Example: registeredBefore=2020-01-01T00:00:00Z
foreignKeysboolean

Include user foreign keys

Example: foreignKeys=true
eventsExportstring

Indicates to export the subscriber events csv file

fromstring

Subscriber event after the specified date

Example: from=2020-01-01T00:00:00Z
tostring

Subscriber event before the specified date

Example: to=2020-01-02T00:00:00Z
rppnumber

Results per page

Default 500
Example: rpp=40
pagenumber

The requested page of results

Default 1
Example: page=1
curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/user-export?attributes=true&attr=attr1.contains.a%2Cattr2.equals.3&appIds=quiz1%2Csurvey4%2Call&appIdsRestrictive=true&grants=true&since=2020-01-01T00%3A00%3A00Z&registeredSince=2020-01-01T00%3A00%3A00Z&registeredBefore=2020-01-01T00%3A00%3A00Z&foreignKeys=true&eventsExport=string&from=2020-01-01T00%3A00%3A00Z&to=2020-01-02T00%3A00%3A00Z&rpp=40&page=1' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - User and user event data have been returned successfully

Bodyapplication/json
resultsArray of objects(user-export-response-items)
metaobject
linksobject
Response
application/json
{
  "results": [
    [ … ]
  ],
  "meta": {
    "count": 100,
    "rpp": 20,
    "paginated": true
  },
  "links": {
    "first": { … },
    "last": { … },
    "previous": { … },
    "next": { … }
  }
}

User Schema

Actions on resource User Schema.

Operations

Users

Contains operations on the User resource. Important: The Attributes object contains the custom-defined attributes for a user.

Operations

V4 Session

Actions on resource Session.

Operations

Webhook

Actions on resource Webhook.

Operations

Account

Actions on resource Account.

Operations

Health Check

Actions on Health checks.

Operations

System Resources

Actions on system resources.

Operations

External Templates

External Templates.

Accounts

Operations

Request Rules Version

Operations

Fetch external template

Request

Fetch External Template

Security
ZephrHmacHttp
Path
templateConfigIdstringrequired

Unique External Template identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/zephr/public/template-components/v1/template-components/{templateConfigId}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
string
Response
application/json
[
  "The template the-value::!"
]

Pages

Operations

Dynamic Offer Promo code redemption

Operations

Subscription

Operations