Welcome to the Alteryx Knowledge Base
Created/Edited -
Overview
This quick guide explains how to use the Alteryx One Application Programming Interface (API). For detailed documentation on available endpoints, visit the official API reference.
How-To Details
The Alteryx One API allows you to perform many of the same tasks available in the Alteryx Analytics Cloud User Interface (UI) — programmatically and at scale. You can automate or script common administrative and workflow operations such as:
- Inviting or removing multiple users at once
- Running plans, flows, or jobs triggered by events
- Creating data connections in batches
Using APIs is particularly useful when you need to automate repetitive tasks or integrate Alteryx One operations into other systems or pipelines.
Applies to: Alteryx One
All supported regions and versions
Any environment with valid API access tokens
Tools used: Command-line clients such as curl, HTTPie, Postman, or Insomnia REST client
Important: When testing or running API calls, you are interacting with live production data. Any changes you make take effect immediately in your production Alteryx One environment.
- A valid Alteryx One account with necessary permissions
- Access to the API Access Tokens Page within your account
- An OAuth 2.0 API token (recommended)
- A third-party REST client installed (for example, curl or Postman)
1. Test the API
curl -X GET 'https://us1.alteryxcloud.com/v4/apiAccessTokens' -H 'Content-type: application/json' -H 'Authorization: Bearer <token>'
2. Understand the request
Key elements to note:
- The header
Content-typemust be set toapplication/json. - Authentication uses a Bearer token — replace
<token>with your valid token (do not include <>).
3. View the response
{
"data": [
{
"tokenId": "<your tokenID>",
"description": "The description of your token",
"createdAt": "The date the token was created",
"expiredAt": "The date the token will expire",
"lastUsed": "Likely the current time",
"person": {
"name": "Your Name",
"email": "Your email",
"id": <your id>
}
}
]
}
Tokens
Token Types
There are two types of tokens:
- Legacy static access tokens — deprecated
- OAuth 2.0 API tokens — recommended
The OAuth 2.0 API tokens provide improved security and control compared to legacy tokens. If you still use legacy tokens created from the Access Tokens Page, migrate to OAuth 2.0 tokens as soon as possible. The legacy tokens were deprecated and are no longer supported for new creation.
Migration deadline: July 11, 2024
Security Notice
Important: Treat all tokens as sensitive credentials. Anyone with your token can act as you within the AAC APIs. Never share or expose tokens in code repositories or shared documents.
- Alteryx Analytics Cloud API Documentation
- Guide to creating and refreshing OAuth 2.0 API Tokens (recommended)
- Guide to creating legacy static Access Tokens (not recommended)