---
sourceDocument: Australia Sales Customer Relationship Management
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/order-management

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Sales Customer Relationship Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# Intro to admin API keys

# Intro to admin API keys {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Intro to admin API keys

ServiceNow CPQ enables you to perform admin functions via API calls using admin API keys, eliminating the need to use the Admin UI and a browser.
This capability streamlines automation and integration by providing programmatic access to ServiceNow CPQ admin features.
Show full answer Show less  

## Accessing Admin API Keys

Within ServiceNow CPQ Admin, you can find the Admin API Keys page by expanding the **Utilities** section. This page allows you to manage your admin API keys, which are necessary credentials for authenticating API requests.

## Creating and Managing Admin API Keys

* **Adding a key:** Click **New** and provide all required fields: Name, User ID, Expiration Date, and Permissions.
* **Permissions:** Assign appropriate permissions based on your use case:
  * **Read:** Default, read-only access mainly for GET requests.
  * **Edit:** Full create, read, update, delete capabilities for most objects.
  * **Deploy:** Permission to deploy blueprints and view deployment history.
  * **Bulk:** Permits importing/exporting data to/from ServiceNow CPQ Admin.
  * **Admin:** Full administrative access to all Admin functionality.
  * **End User Data:** Access to end user data APIs.

Once configured, save the key and immediately copy it since it is only visible upon creation. Safely store the key for future use.

## Using Admin API Keys

Use the admin API key for authentication in API requests by including it as a Bearer Token in the authorization header:

* **Header Key:** authorization
* **Header Value:** Bearer \<Admin API key\>

Example:

`authorization: Bearer QdaUdoiYipb15Le11En8axEuN71FA6Vtcw`

## Endpoints for API Calls

When using admin API keys, note the different endpoint structure compared to the Admin UI:

* **General Admin APIs:** Use `/api/Admin/...` instead of `/a/Admin/...`
* **Managed Tables APIs:** Use `/api/managedTables/...` instead of `/a/managedtables/...`

For example, to retrieve a list of rules or managed table schema, adjust your API calls to these endpoints accordingly.  
You can use admin API calls to access Admin functionality without using the Admin UI interface and a browser.

ServiceNow CPQ provides admin API keys that you can use to access admin functionality via API calls instead of using a browser and the ServiceNow CPQ Admin interface.

For an introduction to ServiceNow CPQ admin API keys, view the following video:

[Admin API keys](https://www.youtube.com/watch?v=8BwQgKw4Dak)

## Admin API keys page {#cpq-admin-api-keys__section_kvl_1cx_2hc}

To get to the Admin API Keys page in ServiceNow CPQ, click the arrow to expand the Utilities section in ServiceNow CPQ Admin. The Admin API Keys tab appears in the menu.

## Add an admin API key {#cpq-admin-api-keys__section_o4h_mcx_2hc}

To add a new admin API key, click New at the top of the screen.

All parameters are required.

1. Name: the name of the admin API key
2. User ID
3. Expiration Date: the expiration date of the key
4. Permissions: the permissions assigned to the key

{#cpq-admin-api-keys__ol_gn1_vcx_2hc}

Choose the permissions that fit your use case before clicking Save.

## Admin API key permissions {#cpq-admin-api-keys__section_dxt_cdx_2hc}

1. Read (required, default): read-only access, typically for GET requests
2. Edit: create, read, update, and delete access for most objects, including fields and rules
3. Deploy: allows the deployment of blueprints and access to deployment history
4. Bulk: allows importing and exporting data, such as managed tables, to and from ServiceNow CPQ
5. Admin: full permissions to all Admin functionality
6. End User Data: access to end user data APIs

{#cpq-admin-api-keys__ol_vbg_kdx_2hc}

When you are finished assigning permissions, click Save. The dialog box updates to show the new admin API key.

1. View the admin API key
2. Copy the key to the clipboard
3. Close the dialog box

{#cpq-admin-api-keys__ol_y3c_g2x_2hc}  
Important:  
You can copy an admin API key only when it is created. Make sure to copy and store the key.

## Accessing admin APIs by using API keys {#cpq-admin-api-keys__section_lh4_vdx_2hc}

To use an admin API key in API requests, use the API key with Bearer Token authentication.

* Header: Authorization Header
* Key: authorization
* Value: Bearer \<Admin API key\>

{#cpq-admin-api-keys__ul_bzg_r2x_2hc}

Example header:

`authorization: Bearer Qda_UdoiYipb15Le11En8axEuN71FA6Vt_cw`

When you use an admin API key, you use different endpoints to access the admin APIs.

* For general Admin endpoints (`/a/Admin/...`) the endpoint to use is (`/api/Admin/...`).

  For example (retrieving a list of rules):
  * API call in Admin UI: `/a/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC`
  * API call using Admin Keys: `/api/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC`
  {#cpq-admin-api-keys__ul_asw_dfx_2hc}
* For managed table endpoints (`/a/managed_tables/...`) the endpoint to use when accessing with an API key is (`/api/managedTables/...`)

  For example (retrieving the schema of a managed table):
  * API call in Admin UI: `/a/managed_tables/v1/managedTables/{tableName}/metadata`
  * API call using Admin Keys: `/api/managedTables/v1/managedTables/{tableName}/metadata`
  {#cpq-admin-api-keys__ul_zff_2fx_2hc}
{#cpq-admin-api-keys__ul_jly_x2x_2hc}
**Related concepts**   

* [Admin APIs: Authentication using a Salesforce-connected app](https://www.servicenow.com/docs/KNtDjQ8uTsTR6QJehjoW1A "We recommend that you use admin API keys to authenticate admin API calls. An older method is documented here.")