---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.com/support/adfox/en/settings/users/assistant-api.md
  - https://yandex.com/support/adfox/ru/settings/users/assistant-api.md
  - href: en/settings/users/assistant-api.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/adfox/en/llms.txt

# API assistant

An API assistant is a user that only has access to the [Adfox API](https://yandex.com/dev/adfox/doc/en/v.1/concepts/access#access__assistant-api-access) methods with no access to the Adfox interface.

In the Adfox API, only the account administrator can access most of the methods. In certain cases, several people working on different tasks in parallel might need access to the API. By adding API assistants, you can issue personal access rights for your employees without disclosing the administrator's password.

{% note warning %}

API Assistants have access **to the entire Adfox account** rather than to individual campaigns, sites, or other objects.

Depending on the selected permission level, a user obtains rights to:

- Read all account objects.
- Read and manage all account objects.
- Read and manage all account objects, as well as manage users.

**It's not recommended** to provide API assistant accounts to external counterparties (for example, advertisers or agencies) unless they need access to the entire account.

{% endnote %}


To enable the API assistant management module, please contact [support](https://yandex.com/support/adfox/en/support/feedback.md).

## Creating an account {#add-assistant-api}

1. In the main menu, open the tab **Users** → **API assistants** and click **+ Add**.

1. The account creation page opens. Fill out the required fields.
    
    <!-- source: en/_includes/users/add-user.md -->
    - **Account**
      
      Come up with a login. You can only use Latin letters, digits, dashes, underscores, and periods. The login must contain between 1 and 32 characters.

      The login must be unique within the Adfox system. If you enter a login that's already taken, a warning appears.

    - **E-mail**
      
      Specify an email address for registration. This address will receive an invitation to the Adfox interface. You register via Yandex ID.
    <!-- endsource: en/_includes/users/add-user.md -->
    
    You can fill out the **Contact information** section after the account creation.
    
1. Specify the access rights for API methods. For a list of available methods, see the [API documentation](https://yandex.com/dev/adfox/doc/en/v.1/concepts/access#access__assistant-api-access):
    
    - **Read-only (RO)**: The assistant can only read the data: get lists (the `list`, `utility`, `info`, `listActiveBanners`, and `listValues` actions) and get reports (the `report` action). They can't add, edit, or delete objects or manage users.

    - **Read and write (RW)**: The assistant can add, edit, and delete objects (settings for the account, sites, campaigns, banners). They can't manage users (`advertiser`, `assistant`, `webmaster`).

    - **Read, write, and manage users (RW + manage users)**: The assistant can run all the methods, including the user management methods.

    The API assistant with the user management permission can't manage other API assistants.
    
1. Click **Add**.

When the module is disabled, the **API assistants** tab is hidden from the interface. The users and objects created by them aren't deleted, but their access to the Adfox API is suspended.

#### Learn more

- [Adfox API documentation](https://yandex.com/dev/adfox/doc/en/)


<!-- source: en/_includes/feedback.md -->
## Contact support


<a href="en/form"> <!--ссылка, куда ведет кнопка. Если внутренняя ссылка, пишем без .md и .html --> 
  <span class="button">Send an email</span> <!--текст на кнопке--> 
</a>



<!-- source: en/_includes/styles/button.md -->

<!-- endsource: en/_includes/styles/button.md -->
<!-- endsource: en/_includes/feedback.md -->