API reference
Saved views
Saved list filters.
GET/saved-views
List saved views
Needs the permission saved_views:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
entity required | query | one of lead, contact |
curl -X GET https://crm.anibrosdesign.com/api/v1/saved-views \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/saved-views
Create a saved view
Needs the permission saved_views:manage.
| Body field | Type | Notes |
|---|---|---|
entity required | one of lead, contact | |
name required | string | at least 1 characters. up to 80 characters |
filters required | object of any | |
sort | string or null | |
isShared | boolean |
curl -X POST https://crm.anibrosdesign.com/api/v1/saved-views \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"entity":"lead","name":"text","filters":{}}'Responses:
201 400 401 402 403 429
PATCH/saved-views/{id}
Change a saved view
Needs the permission saved_views:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
name | string | at least 1 characters. up to 80 characters |
filters | object of any | |
sort | string or null | |
isShared | boolean |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/saved-views/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","filters":{},"sort":"text"}'Responses:
200 400 401 402 403 404 412 429
DELETE/saved-views/{id}
Delete a saved view
Needs the permission saved_views:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X DELETE https://crm.anibrosdesign.com/api/v1/saved-views/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
Something missing or unclear? Tell us.