API Reference/Saved

Saved

For authentication instructions, see API overview.

Endpoints

get/api/v2/savedFilters

post/api/v2/savedFilters

get/api/v2/savedFilters/:id

put/api/v2/savedFilters/:id

patch/api/v2/savedFilters/:id

delete/api/v2/savedFilters/deleted/:id

get

List all saved filters

Returns a list of saved filters. The saved filters are returned in sorted order, with the most recent appearing first.

Query parameters

limitinteger
The number of records to return
pageinteger
The page number
orderstring
The order of the records
sortBystring
The sort of the records
fieldsstring
The filter of the records
pstring
policyFilters
qstring
search query

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/savedFilters

Response

No response schema

post

Create saved filters

Create saved filters. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

namestring
filtersarray
activeboolean
usersarray
objectstring
scopestring

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/savedFilters \
	-d 'name="filter1"' \
	-d 'filters="array"' \
	-d 'active=true' \
	-d 'users="array"' \
	-d 'object="lead"' \
	-d 'scope="private"'

Response

No response schema

get

Retrieve saved filters

Returns a single saved filter, which you can request by passing through an id in the url.

Path parameters

idstring
ID of the saved filter

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/savedFilters/:id

Response

No response schema

put

Update saved filters

Path parameters

idstring
ID of the saved filter

Request body

namestring
filtersarray
activeboolean
usersarray
objectstring
scopestring

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/savedFilters/:id \
	-d 'name="filter1"' \
	-d 'filters="array"' \
	-d 'active=true' \
	-d 'users="array"' \
	-d 'object="lead"' \
	-d 'scope="private"'

Response

No response schema

patch

Update saved filters soft

Update saved filters soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

idstring
ID of the saved filter

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/savedFilters/:id

Response

No response schema

delete

Delete saved filters

Path parameters

idstring
ID of the saved filter

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/savedFilters/deleted/:id

Response

No response schema