> For the complete documentation index, see [llms.txt](https://docs.userlane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.userlane.com/developer-reference/your-userlane-api-token.md).

# Your Userlane API token

Generate and manage the API token used to authenticate data export and import requests.

The Userlane API token is a single credential for moving data between Userlane and other systems programmatically, rather than by hand in the Portal. One token covers everything the API can do, both reading data out of Userlane and pushing data in.

This article covers the token itself. Each linked article below covers one task in detail.

## What the token covers

The token gives access to two kinds of operation.

**Export data out of Userlane.** Pull Userlane data into another tool, such as a business intelligence dashboard, a data warehouse, or an internal report. Available exports:

* Guide, Guide progress, and Announcement events: how users interact with in-app content.
* HEART Score, NPS, Survey, Tag, and Task data: analytics and feedback.
* User profile data: details and attributes on end users.

**Push data into Userlane.** Send data from another system into Userlane so that content can use it. Currently available:

* User attributes: push attributes such as role, region, or license type from any system, so that content targeting and audience analysis can use data Userlane does not collect itself.

## Generate the token

Generate the token in the Userlane Portal under **Settings > API Token**.

{% hint style="info" %}
The token is generated per Userlane Manager. A new token can be generated at any time using the same button in the Portal. Generating a new token replaces the old one, so any integration using the previous token has to be updated.
{% endhint %}

## Who this is for

Working with the API requires technical knowledge, so involving a developer is recommended. An administrator generates and manages the token, and a developer uses it to build the integration.

## Access levels

Some operations require the token's Manager to hold admin rights. Pushing user attributes, for example, requires a company admin. If an integration returns a permission error, check that the token belongs to a Manager with the right level of access.

## Relevant articles

{% content-ref url="/pages/YQr5VKi5bSxWYT6o6dOi" %}
[Export Guides, Guide progress, and Announcement data via API](/developer-reference/export-guides-guide-progress-and-announcement-data-via-api.md)
{% endcontent-ref %}

{% content-ref url="/pages/pFJIN3rpdCcXyo6ifg4j" %}
[Export HEART, NPS, Survey, Tag, and Task data via API](/developer-reference/export-heart-nps-survey-tag-and-task-data-via-api.md)
{% endcontent-ref %}

{% content-ref url="/pages/0XiPZYLLfKewriq8G6Av" %}
[User profile data export](/developer-reference/user-profile-data-export.md)
{% endcontent-ref %}

{% content-ref url="/pages/ZTVMq8E5zKZ7JFbGC4gI" %}
[Push user attributes via API](/developer-reference/push-user-attributes-via-api.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.userlane.com/developer-reference/your-userlane-api-token.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
