View Sets

View sets are groups of views that determine what contacts see in the Client Portal. Use the View Sets API to manage and assign these sets to contacts.

Overview


Base route	`/v1/view_sets`
Produces	JSON
Pagination	Yes
OAuth scopes	`USERS`

Access requirements

Application permissions: "API Access: Create, edit, and delete" and "Full Access" for all operations.

Resource overview

View sets contain the below attributes. Required attributes are noted in the description.

All attributes will be returned in successful GET responses containing the view sets resource.

Attribute	Description
`name`	The view set's name. String. Example: `"Firm View Set"`
`views`	A list of objects representing the views in a set. See below for object details.

View objects

Attribute	Description
`id`	The view's unique identifier. String. Example: `"16"`
`name`	The view's name. String. Example: `"Benchmarks"`
`type`	The type of view, such as Analysis or Transaction. String. Example: `"TRANSACTION_TYPE"`

Get a view set

Retrieves details for a specific view set.

GET /v1/view_sets/:id

Authentication

This endpoint requires a valid API key or OAuth token with the USERS scope. Pass credentials via the Authorization header.

Example:

curl -X GET "https://{firm}.addepar.com/api/v1/view_sets/2000" \
  -H "Authorization: Basic {credentials}" \
  -H "Addepar-Firm: 1" \
  -H "Accept: application/vnd.api+json"

{
    "data":{
        "id":"2000",
        "type":"view_sets",
        "attributes":{
            "name":"Firm View Set",
            "views": [
                {
                    "id": "16",
                    "name": "Benchmarks",
                    "type": "TRANSACTION_TYPE"
                }
            ]
        },
        "links": {
            "self": "/v1/view_sets/2000"
        }
    }
}

Response codes

200 OK -- Success
403 Forbidden -- You need full access permissions to perform this action
404 Not Found -- View set not found

Get all view sets

Retrieves details for all view sets.

GET /v1/view_sets