---
title: "Operator API guide"
slug: "operator-api-guide"
updated: 2024-10-03T18:00:40Z
published: 2024-10-03T18:00:40Z
canonical: "support.tulip.co/operator-api-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.tulip.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Operator API guide

*Learn how to set up the Operator API*

**Access Tulip's [API documentation here](https://support.tulip.co/apidocs).**

          Advanced Content

          

This article assumes previous experience with APIs.

Adding operators to your site is necessary to populate the users who will be running the Apps developed in Tulip. You can create Operators two ways:

- [The Users page](https://support.tulip.co/docs/adding-users-and-managing-user-roles), located in **Settings**
- Use an external system via the Tulip API.

The procedure below demonstrates how to use the Tulip API to create operators.

## Add an Operator API Token

In your Tulip instance, click your **profile icon** in the top right corner and select **Settings**.

![Configuring Your Tulip Account Settings_124925135](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Configuring%20Your%20Tulip%20Account%20Settings_124925135.png)

Select **API Tokens** then click the **Create API Token** button at the top right.

![Create%20API%20token1](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Create%20API%20token1.png)

In the Creation menu, give the API Token a **name** and select the `users:write` scope. Click **Create**.

![Create API Token](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Create%20API%20Token.gif)

          Note

          

Make sure to save the API Token information for the **API Key**, **Secret**, and **Authorization Header**.

## Using the Operator API

The following will go through how to create an operator. In this case, the example will use [Postman](https://www.postman.com/) to perform the creation.

First, add your API endpoint to the Post request.

          NOTE

          

If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.

*https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users*

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Using%20the%20Operator%20API_222496924.png)

Then, under Authorization, select **Basic Auth** and enter the API Key as the **Username**, and the API Secret as the **Password**.

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Using%20the%20Operator%20API_222497720.png)

Under Headers, add the **Auth Header**.

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Using%20the%20Operator%20API_222497957.png)

In the Body, format the request to take in the JSON object. The generic format for this request is as follows.

`{ "role": "operator", "name": "string", "badge_id": "string" }`

This will look something like this:

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Using%20the%20Operator%20API_222499033.png)

Click **Send** to run the request, and you will receive a 201 response to indicate success. To verify, you can check your list of Users in **Settings**, and confirm the user was successfully created.

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Using%20the%20Operator%20API_222499593.png)

If the request failed, check that the Key and Secret are correct. For more information on specific response codes, see [Introduction to APIs](/r230/docs/introduction-to-apis).

---

Did you find what you were looking for?

You can also head to [community.tulip.co](https://community.tulip.co/?utm_source=intercom&utm_medium=article-link&utm_campaign=all) to post your question or see if others have faced a similar question!

**JSON**

**JSON (JavaScript Object Notation)** is a light-weight, text-based data format that is used to store and transfer data.