Skip to main content

Getting Started with Alteryx Cloud APIs

The Alteryx Cloud APIs let you manage workspaces, users, plans, schedules, workflows and billing in Alteryx Analytics Cloud from your own code. Browse what is available under Cloud APIs.

Try an API from this site

  1. Sign in to Alteryx Analytics Cloud.
  2. Open an endpoint, for example Read current workspace.
  3. Select "Send API Request". The request runs as you, in the workspace you are signed in to.
  4. If the response is a 401, your session has expired. Sign in again in the tab that opens, then send the request again.

Call the APIs from your own code

Each endpoint's page lists the credentials it accepts under "Accessible using". Send the access token in the Authorization header.

OAuth 2.0 API tokens

Use these to call the APIs as yourself. Generate an access token and a refresh token in OAuth 2.0 API Tokens. The workspace must have API tokens enabled. Access tokens expire, so use the refresh token to get a new one, as described in the Cloud API example code.

curl https://api.au1.alteryxcloud.com/iam/v1/workspaces/current \
-H "Authorization: Bearer $ACCESS_TOKEN"

Service principals

Use these for automation that should not depend on a person's account. Workspace admins manage them in Service Principals. Creating one gives you a client ID, a client secret and a token endpoint. Get an access token from the token endpoint with the OAuth 2.0 client credentials grant.

curl -X POST "$TOKEN_ENDPOINT" \
-d grant_type=client_credentials \
--data-urlencode client_id="$CLIENT_ID" \
--data-urlencode client_secret="$CLIENT_SECRET"

Resources