Skip to content
/Company

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

List companies

Request

Retrieves a list of companies wrapped in the element "results".

Security
ZephrHmacHttp
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/companies \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
namestring
Example: "Company name"
descriptionstring
Example: "Company description"
websitestring
Example: "company.com"
contactstring
Example: "Company contact"
account_managerstring
Example: "Company account manager"
]
Response
application/json
{
  "results": [
    { … }
  ]
}

Create a company

Request

Creates a company.

Security
ZephrHmacHttp
Bodyapplication/json
namestring
Example: "Company name"
descriptionstring
Example: "Company description"
websitestring
Example: "company.com"
contactstring
Example: "Company contact"
account_managerstring
Example: "Company account manager"
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/companies \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Company name",
    "description": "Company description",
    "website": "company.com",
    "contact": "Company contact",
    "account_manager": "Company account manager"
  }'

Responses

Created

Retrieve a company

Request

Retrieves a single company.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Company identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/companies/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
namestring
Example: "Company name"
descriptionstring
Example: "Company description"
websitestring
Example: "company.com"
contactstring
Example: "Company contact"
account_managerstring
Example: "Company account manager"
Response
application/json
{
  "name": "Company name",
  "description": "Company description",
  "website": "company.com",
  "contact": "Company contact",
  "account_manager": "Company account manager"
}

Delete a company

Request

Deletes a company.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Company identifier

curl -i -X DELETE \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/companies/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Update a company

Request

Updates a company.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Company identifier

Bodyapplication/json
namestring
Example: "Company name"
descriptionstring
Example: "Company description"
websitestring
Example: "company.com"
contactstring
Example: "Company contact"
account_managerstring
Example: "Company account manager"
curl -i -X PUT \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/companies/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Company name",
    "description": "Company description",
    "website": "company.com",
    "contact": "Company contact",
    "account_manager": "Company account manager"
  }'

Responses

Created

Create a company

Request

Creates a company with the details specified in the request body

Security
ZephrHmacHttp
Bodyapplication/json
namestringrequired

The name of the company

Example: "Company name"
descriptionstring

The description of the company

Example: "Company description"
websitestring

The website of the company

Example: "https://company.com"
contactstring

Contact information of the company

Example: "company@email.com"
account_managerstring

The name of the company account manager

Example: "Joe Blow"
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/companies \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Company name",
    "description": "Company description",
    "website": "https://company.com",
    "contact": "company@email.com",
    "account_manager": "Joe Blow"
  }'

Responses

OK - Company has been created successfully

Retrieve a company

Request

Retrieves company information for a company specified by the provided identifier (companyId)

Security
ZephrHmacHttp
Path
companyIdstringrequired

The company's unique identifier

Example: 1f6841a8-7f3b-4505-856e-4549be433545
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/companies/1f6841a8-7f3b-4505-856e-4549be433545 \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - Company information was successfully retrieved

Bodyapplication/json
company_idstring

Company identifier

Example: "1f6841a8-7f3b-4505-856e-4549be433545"
namestring

Company name

Example: "My Company"
descriptionstring

Company description

Example: "This is an example company"
websitestring

Company website

Example: "https://company.com"
contactstring

The company's contact information

Example: "email@company.com"
account_managerstring

Company account manager

Example: "Joe Blow"
tenantIdstring

Tenant identifier

Example: "my-tenant"
subTenantIdstring

Sub-tenant identifier (it will match the tenantId if the company is not part of a super tenant)

Example: "my-tenant"
Response
application/json
{
  "company_id": "1f6841a8-7f3b-4505-856e-4549be433545",
  "name": "My Company",
  "description": "This is an example company",
  "website": "https://company.com",
  "contact": "email@company.com",
  "account_manager": "Joe Blow",
  "tenantId": "my-tenant",
  "subTenantId": "my-tenant"
}

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

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