API Endpoints for Designer Cloud Powered by Trifacta Starter Edition
Warning
API access is migrating to Enterprise only. Beginning in Release 9.5, all new or renewed subscriptions have access to public API endpoints on the Enterprise product edition only. Existing customers on non-Enterprise editions will retain access their available endpoints (Legacy) until their subscription expires. To use API endpoints after renewal, you must upgrade to the Enterprise product edition or use a reduced set of endpoints (Current). For more information on differences between product editions in the new model, please visit Pricing and Packaging.
The following endpoints are available for Starter Edition.
To access the reference documentation for each available API endpoint and method, select Resources menu > API documentation in the Trifacta Application.
Current
For Starter Edition workspaces created after Release 9.5, the following endpoints are available.
Flow
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows/package | Import Flow package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows | List flows | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/package | Export flow | Designer Cloud Powered by Trifacta: API Reference docs |
JobGroup
Path | Description | Documentation URL |
|---|---|---|
GET /v4/jobGroups/:id | Get job group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/jobs | Get Jobs for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
Misc
Path | Description | Documentation URL |
|---|---|---|
GET /v4/open-api-spec | Get OpenAPI specification | Designer Cloud Powered by Trifacta: API Reference docs |
Person
Path | Description | Documentation URL |
|---|---|---|
GET /v4/people/current | Get Current Person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people/:id | Get person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people | List people | Designer Cloud Powered by Trifacta: API Reference docs |
Workspace
Path | Description | Documentation URL |
|---|---|---|
PATCH /v4/workspaces/current/transfer | Transfer User Assets | Designer Cloud Powered by Trifacta: API Reference docs |
Legacy
For Starter Edition workspaces created before Release 9.5, the following endpoints are available.
Flow
Path | Description | Documentation URL |
|---|---|---|
POST /v4/flows/package | Import Flow package | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows | List flows | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/flows/:id/package | Export flow | Designer Cloud Powered by Trifacta: API Reference docs |
JobGroup
Path | Description | Documentation URL |
|---|---|---|
GET /v4/jobGroups/:id | Get job group | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/jobGroups/:id/jobs | Get Jobs for Job Group | Designer Cloud Powered by Trifacta: API Reference docs |
Misc
Path | Description | Documentation URL |
|---|---|---|
GET /v4/open-api-spec | Get OpenAPI specification | Designer Cloud Powered by Trifacta: API Reference docs |
Person
Path | Description | Documentation URL |
|---|---|---|
GET /v4/people/current | Get Current Person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people/:id | Get person | Designer Cloud Powered by Trifacta: API Reference docs |
GET /v4/people | List people | Designer Cloud Powered by Trifacta: API Reference docs |
Workspace
Path | Description | Documentation URL |
|---|---|---|
PATCH /v4/workspaces/current/transfer | Transfer User Assets | Designer Cloud Powered by Trifacta: API Reference docs |