> The Account Services V1 endpoints have been deprecated and will be retired on May 13, 2026. If you are using `https://api.maxar.com/account-service/api/v1/`, migrate to `https://api.maxar.com/account-service/api/v2/`. All documentation for Account Services shows the V2 endpoints.

# Account Services (Admin API)

The Account Services API lets account administrators (admins) manage users and view information for their account and activation. Account Services tasks can be performed using the Vantor Hub admin user interface (UI) or through direct API access. Admins can view their account details and manage users in their account.

[Vantor Hub admin UI](https://account.maxar.com)

[Vantor Hub administration documentation](https://pro-admin-docs.maxar.com)

[Account Services API Collection zip file](/downloads/account_services_api.zip)

> Permissions level required:
>
> ![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAA+gAwAEAAAAAQAAAA8AAAAA9Ay2CgAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAAAhxJREFUKBVVUj1vE0EQnd21DyTiS4oIoxA+BBQEiTIFLtyAoEGiBkFhiegcxI+4iF9AYfsuTQro7IaCgkghAvEPoKJIgRAIZEWKZeIod7fLm7mNYo90up037+28mTtF0+GcIqXcXJI0NVFTSsCsUp/G7fZn8vUTCTg+4lizsNbtPtfO3XNKDejwsGutHSC/zzjXiXkz4YFap9MIk+TVTM0njNeS5I6knl/eEsdOQGMaxtq+nNO0Kjb5jQBxYJxrSM3zTyyIHW1tkOX5byFEUS42+Y3Ig+CXc+6Mty3NSjEvIo6tJToyQXDF3y4dgZedJ5Or2MOEeeIIpFK8saFYYLTewe1PvPh45q31Y63UR8E8X0QC8GxRlM0nyV04eIDb3xVa72EH12D/Ebp8OGi3d8jzWFN25u1BGHY6qxjmYkWpNxDfMEXxVCl1nXM4Wgo3N1eZ5+cmnlXzHLVe7yE6NLG0Pcy2BPF30npI1i4iX0GXn2h22Wn9ZRRF71knts+l6W10eTHa3X1J/X4x1+udrxDdgnjBFcU4r1a//ltb+8OCsF5/jbHS8fr6N3CIKtau4BfcZiFtbZ0dt1p/AfNzGsCp1TpySbIN8CaeUmydO1Zal9sF4VQxdfI4f06MJo6lM2YKkIVia3l5ASMUUzI5FsaYURgemP39RTTLGBQxfvwfWNaz+Xr9ksuyKpQO887qs0yFw2EO/AK+91su/germ/ao2QT5mgAAAABJRU5ErkJggg==) Admin

## Password Management[​](#password-management "Direct link to Password Management")

Access to the Vantor Hub user interfaces and APIs requires a Vantor Hub account with a valid username and password. Passwords expire every 90 days and must be reset.

Account users can reset their own passwords by following these instructions: [Manage Your Password](https://pro-admin-docs.maxar.com/en-us/Account/Account_password.htm).

Admins can send a password reset email to users through the UI or through direct API access. To send a password reset email using the UI, following these instructions for the UI [Resetting User Passwords](https://pro-admin-docs.maxar.com/en-us/Admin/Users/Users_password.htm). To send a password reset email using the API, submit a [Send Password Reset Email](/docs/admin/api/send-password-reset-email) call.

## User guides and examples[​](#user-guides-and-examples "Direct link to User guides and examples")

| Page                                                        | Topic                                                                  |
| ----------------------------------------------------------- | ---------------------------------------------------------------------- |
| [Account Services Guide](/docs/admin/guides/admin-guide.md) | An overview of the Account Services API collection.                    |
| [Accounts Guide](/docs/admin/guides/accounts.md)            | A list of all available Account Services calls related to Accounts.    |
| [Activations Guide](/docs/admin/guides/activations.md)      | A list of all available Account Services calls related to Activations. |
| [Products Guide](/docs/admin/guides/products.md)            | A list of all available Account Services calls related to Products.    |
| [Rate Tables Guide](/docs/admin/guides/rate-tables.md)      | A list of all available Account Services calls related to Rate Tables. |
| [Roles Guide](/docs/admin/guides/roles.md)                  | A list of all available Account Services calls related to Roles.       |
| [Scopes Guide](/docs/admin/guides/scopes.md)                | A list of all available Account Services calls related to Scopes.      |
| [Usage Guide](/docs/admin/guides/usage.md)                  | A list of all available Account Services calls related to Usage.       |
| [Users Guide](/docs/admin/guides/users.md)                  | A list of all available Account Services calls related to Users.       |

## API references[​](#api-references "Direct link to API references")

| Page                                                                              | Topic                                                                     |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `POST` [Get an OAuth2 bearer token](/docs/admin/api/get-an-o-auth-2-bearer-token) | Get an OAuth2 bearer token for authentication use in this API collection. |

### Accounts[​](#accounts "Direct link to Accounts")

| Page                                                             | Topic                             |
| ---------------------------------------------------------------- | --------------------------------- |
| `GET` [Get Account Details](/docs/admin/api/get-account-details) | Get the details for your account. |
| `GET` [Get Account Usage](/docs/admin/api/get-account-usage)     | Get the usage for your account.   |

### Activations[​](#activations "Direct link to Activations")

| Page                                                                                                                     | Topic                                                           |
| ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
| `GET` [Get a list of available activations](/docs/admin/api/get-a-list-of-available-activations)                         | Get a list of activations available to your account.            |
| `GET` [Get an activation by activationId](/docs/admin/api/get-an-activation-by-activation-id)                            | Get the details of an activation using its activationId.        |
| `GET` [Get an activation by activation number](/docs/admin/api/get-an-activation-by-activation-number)                   | Get the details of an activation using its activation number.   |
| `GET` [Get georestrictions attached to activation](/docs/admin/api/get-georestrictions-attached-to-activation)           | Get any georestrictions attached to a specific activation.      |
| `GET` [Get georestriction masks attached to activation](/docs/admin/api/get-georestriction-masks-attached-to-activation) | Get any georestriction masks attached to a specific activation. |
| `GET` [Get activation's credit limit](/docs/admin/api/get-activations-credit-limit)                                      | Get the credit limit for a specific activation.                 |
| `GET` [Get activation's usage](/docs/admin/api/get-activations-usage)                                                    | Get the current usage of a specific activation.                 |

### Products[​](#products "Direct link to Products")

| Page                                                                   | Topic                                             |
| ---------------------------------------------------------------------- | ------------------------------------------------- |
| `GET` [Get a list of products](/docs/admin/api/get-a-list-of-products) | Get a list of products available to your account. |

### Rate Tables[​](#rate-tables "Direct link to Rate Tables")

| Page                                                                                                                         | Topic                                                                                                                        |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `GET` [Get rate tables](/docs/admin/api/get-rate-tables)                                                                     | Get a list of rate tables available to your account.                                                                         |
| `GET` [Get rate table by ID](/docs/admin/api/get-rate-table-by-id)                                                           | Get the details of a rate table using its ID.                                                                                |
| `GET` [Get activations for rate table](/docs/admin/api/get-activations-for-rate-table)                                       | Get all activations that are using a specific rate table.                                                                    |
| `GET` [Get product credit rates for rate tables](/docs/admin/api/get-product-credit-rates-for-rate-tables)                   | Get a list of all product credits.                                                                                           |
| `GET` [Get product credit rates for a rate table](/docs/admin/api/get-product-credit-rates-for-a-rate-table)                 | Get a breakdown of how many credits it costs to order a unit of various products for a specific rate table.                  |
| `GET` [Get credit rates for single product in rate table](/docs/admin/api/get-credit-rates-for-single-product-in-rate-table) | Get how many credits it costs to order a unit of a specific product for a specific rate table.                               |
| `GET` [Get rate tables and associated activation numbers](/docs/admin/api/get-rate-tables-and-associated-activation-numbers) | Get a list of all rate tables available to your account and the associated activations that are able to use that rate table. |
| `GET` [Get rate table prod cred by activation number](/docs/admin/api/get-rate-table-prod-cred-by-activation-number)         | Get the rate table associated with a specific activation and the cost per unit of all available products.                    |
| `GET` [Get a list of all credit unit types](/docs/admin/api/get-a-list-of-all-credit-unit-types)                             | Get a list all credit unit types.                                                                                            |

### Roles[​](#roles "Direct link to Roles")

| Page                                                                       | Topic                                     |
| -------------------------------------------------------------------------- | ----------------------------------------- |
| `GET` [Get roles account](/docs/admin/api/get-roles-account)               | Get the roles available for your account. |
| `GET` [Get a list of user types](/docs/admin/api/get-a-list-of-user-types) | Get all user types.                       |
| `GET` [Get role by ID](/docs/admin/api/get-role-by-id)                     | Get a role by ID.                         |

### Scopes[​](#scopes "Direct link to Scopes")

| Page                                                           | Topic                                      |
| -------------------------------------------------------------- | ------------------------------------------ |
| `GET` [Get Scopes](/docs/admin/api/get-scopes)                 | Get the scopes available for your account. |
| `GET` [Get Scopes by ID](/docs/admin/api/get-scopes-by-id)     | Get scopes by ID.                          |
| `GET` [Get Scopes by Name](/docs/admin/api/get-scopes-by-name) | Get scopes by scope name.                  |

### Usage[​](#usage "Direct link to Usage")

| Page                                                               | Topic                                                                |
| ------------------------------------------------------------------ | -------------------------------------------------------------------- |
| `GET` [Get Activation Usage Overview](/docs/admin/api/check-usage) | Get the usage overview for the activation associated with your user. |

### Users[​](#users "Direct link to Users")

| Page                                                                                                                                | Topic                                                                                                 |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `POST` [Add a new user](/docs/admin/api/add-a-new-user)                                                                             | Add a new user to your account.                                                                       |
| `POST` [Assign roles to a user](/docs/admin/api/assign-roles-to-a-user)                                                             | Assign roles to a user that have not already been assigned at the account or activation level.        |
| `POST` [Remove role from a user](/docs/admin/api/remove-role-from-a-user)                                                           | Remove roles from a user. This can include roles assigned at the, account, activation, or user level. |
| `GET` [Get a list of users](/docs/admin/api/get-a-list-of-users)                                                                    | Get a list of all users associated with your account.                                                 |
| `PUT` [Send a password reset email](/docs/admin/api/send-password-reset-email)                                                      | Send a password reset email to a specific user.                                                       |
| `GET` [Get all roles assigned to and available for a user](/docs/admin/api/get-all-assigned-roles-and-available-roles-for-the-user) | Get all assigned roles and available roles for a specific user.                                       |
| `GET` [Get all roles assigned to a user](/docs/admin/api/get-all-the-roles-that-belong-to-the-user)                                 | Get all the roles currently assigned to a specific user.                                              |
| `GET` [Get a user by username](/docs/admin/api/get-a-user-by-username)                                                              | Get a specific user by their username (email address).                                                |
| `DEL` [Delete a user](/docs/admin/api/delete-a-user)                                                                                | Delete a user.                                                                                        |
| `GET` [Get users' usage](/docs/admin/api/get-users-usage)                                                                           | Get the credit usage for all users associated with your account.                                      |
| `PUT` [Update a user](/docs/admin/api/update-a-user)                                                                                | Update information associated with a specific user.                                                   |
| `GET` [Get georestrictions](/docs/admin/api/get-georestrictions)                                                                    | Get the georestrictions associated with a specific user.                                              |
| `GET` [Get georestricion masks](/docs/admin/api/get-georestriction-masks)                                                           | Get the georestriction masks associated with a specific user.                                         |
| `GET` [Export user data](/docs/admin/api/export-user-data)                                                                          | Export a CSV file of all user data associated with your account.                                      |