How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Alteryx Collections API

Manage collections of workflows, schedules, users, and user groups

Alteryx Collections API is one of 12 APIs that Alteryx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 15 operations across 12 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://{serverHostname}/webapi.

15 operations 12 paths 3 schemas 5 DELETE2 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
https://your-server/webapi
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Alteryx Collections API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authentication using API Access Key and API Access Secret obtained from the Server User Interface under the Keys section.

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 5 DELETE, 2 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Collections 15

Manage collections of workflows, schedules, users, and user groups

POST
/v3/collections
Create a New Collection
createCollection body → 201400401
GET
/v3/collections
Retrieve All Collections
getCollections 1 param → 200401
GET
/v3/collections/{collectionId}
Retrieve a Specific Collection
getCollection 1 param → 200401404
PUT
/v3/collections/{collectionId}
Update a Collection
updateCollection 1 param body → 200400401404
DELETE
/v3/collections/{collectionId}
Delete a Collection
deleteCollection 2 params → 200400401404
POST
/v3/collections/{collectionId}/users
Add a User to a Collection
addUserToCollection 1 param body → 200400401
PUT
/v3/collections/{collectionId}/users/{userId}/permissions
Update User Permissions in a Collection
updateCollectionUserPermissions 2 params body → 200401404
DELETE
/v3/collections/{collectionId}/users/{userId}
Remove a User From a Collection
removeUserFromCollection 2 params → 200401404
POST
/v3/collections/{collectionId}/userGroups
Add a User Group to a Collection
addUserGroupToCollection 1 param body → 200400401
PUT
/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions
Update User Group Permissions in a Collection
updateCollectionUserGroupPermissions 2 params body → 200401404
DELETE
/v3/collections/{collectionId}/userGroups/{userGroupId}
Remove a User Group From a Collection
removeUserGroupFromCollection 2 params → 200401404
POST
/v3/collections/{collectionId}/workflows
Add a Workflow to a Collection
addWorkflowToCollection 1 param body → 200400401
DELETE
/v3/collections/{collectionId}/workflows/{appId}
Remove a Workflow From a Collection
removeWorkflowFromCollection 2 params → 200401404
POST
/v3/collections/{collectionId}/schedules
Add a Schedule to a Collection
addScheduleToCollection 1 param body → 200400401
DELETE
/v3/collections/{collectionId}/schedules/{scheduleId}
Remove a Schedule From a Collection
removeScheduleFromCollection 2 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CollectionUserPermission (7 properties), CollectionPermissionFlags (6 properties), Collection (4 properties). Each schema is shown below with its type and property counts.

CollectionPermissionFlags
object
Permission flags for collection access
6 properties
Collection
object
A collection of workflows, schedules, and users
4 properties
CollectionUserPermission
object
User permissions within a collection
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alteryx-collections-api-openapi.yml Raw ↑

Other APIs Alteryx publishes across the network.

Alteryx Server API
Alteryx Server API V1
Alteryx Gallery API
Alteryx Connect API
Alteryx AlteryxEngine API
Alteryx Designer Cloud API
Alteryx Credentials API
Alteryx Jobs API
Alteryx Schedules API
Alteryx Users API
Alteryx Workflows API
Where this information came from

This is an independent, third-party profile of Alteryx Collections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.