View Sets
View sets are groups of views that determine what contacts see in the Client Portal. You can use the View Sets API to manage and assign these sets to contacts.
Base Route | /v1/view_sets |
Endpoints | GET /v1/view_sets/:id /v1/view_sets |
Produces | JSON |
Pagination | Yes |
Application Permissions Required | "API Access: Create, edit, and delete" "Full Access" for all operations. |
OAuth Scopes | GETUSERS_READ |
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 | Example |
---|---|---|
name | The view set's name. String. | "Firm View Set" |
views | A list of objects representing the views in a set. See below for object details. | See below. |
View objects
Attribute | Description | Example |
---|---|---|
id | The view’s unique identifier. String. | "16" |
name | The view’s name. String. | "Benchmarks" |
type | The type of view, such as Analysis or Transaction. String. | "TRANSACTION_TYPE" |
Get a view set
Retrieves details for a specific view set.
GET /v1/view_sets/:id
Example:
GET https://examplefirm.addepar.com/api/v1/view_sets/2000
HTTP/1.1 200
{
"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
: Success403 Forbidden
: You need full access permissions to perform this action404 Not Found
: View set not found
Get all view sets
Retrieves details for all view sets.
GET /v1/view_sets
Example:
GET https://examplefirm.addepar.com/api/v1/view_sets
HTTP/1.1 200
{
"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
: Success403 Forbidden
: You need full access permissions to perform this action
Updated 25 days ago