Page tree

Outdated release! Latest docs are Release 8.2: API Deployments Get List v4


For the latest updates on available API endpoints and documentation, see

This is the latest version of the APIs.


Get the list of accessible deployments for the authenticated user.

NOTE: Deployments pertain to Production instances of the Trifacta® platform. For more information, see Overview of Deployment Manager.


Required Permissions

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.


Request Type: GET



Endpoint with paged retrieval:

By default, this endpoint returns results in sets of 25. 

You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:


If the count of retrieved results is less than the limit, you have reached the end of the results.

Query Parameter reference:

The following query parameters are supported for this type of endpoint.

Query ParameterData TypeDescription

Comma-separated list of objects to include part of the response.


If set to true, response includes deleted objects.


Maximum number of objects to fetch. Default: 25.


If set to true, response does not limit the number of objects.


Offset after which to start returning objects. For use with limit query parameter.


Defines sort order for returned objects.


Comma-separated list of fields against which to match the  filter  parameter. Default: name


Value for fuzzy-filtering objects. See  filterFields .


(some endpoints) Internal value. Do not modify.

sharedRolestring(some endpoints) The role type required to list the connection
flowFilterstring(some endpoints) The type of flows to list. Values: all, shared, owned

The following query parameters are specific to this endpoint:

Query ParameterDescription
deploymentIdInternal identifier of the deployment

For more information, see API Common Query Parameters v4.

Request Body:



Response Status Code - Success:  200 - OK

Response Body Example:

    "data": [
            "id": 2,
            "name": "Test Deployment 2",
            "createdAt": "2019-02-13T20:15:39.147Z",
            "updatedAt": "2019-02-13T20:15:39.147Z",
            "numReleases": 0,
            "latestRelease": null,
            "creator": {
                "id": 7
            "updater": {
                "id": 7
            "id": 1,
            "name": "Test Deployment",
            "createdAt": "2019-02-13T20:14:48.537Z",
            "updatedAt": "2019-02-13T20:14:48.537Z",
            "numReleases": 0,
            "latestRelease": null,
            "creator": {
                "id": 7
            "updater": {
                "id": 7


For more information on the properties of a deployment, see API Deployments Get v4

This page has no comments.