Favorites API Reference
API Reference/Favorites

Favorites

For authentication instructions, see API overview.

Endpoints

get/api/v2/favorites
post/api/v2/favorites
get/api/v2/favorites/:id
put/api/v2/favorites/:id
patch/api/v2/favorites/:id
delete/api/v2/favorites/deleted/:id
get

List all favorites

Returns a list of favorites. The favorites 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/favorites

Response

No response schema
post

Create favorites

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

Request body

  • leadsarray
  • unitsarray

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/favorites \
	-d 'leads="array"' \
	-d 'units="array"'

Response

No response schema
get

Retrieve favorites

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

Path parameters

  • idstring

    ID of the favorite

Request

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

Response

No response schema
put

Update favorites

Path parameters

  • idstring

    ID of the favorite

Request body

  • leadsarray
  • unitsarray

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/favorites/:id \
	-d 'leads="array"' \
	-d 'units="array"'

Response

No response schema
patch

Update favorites soft

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

Path parameters

  • idstring

    ID of the favorite

Request

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

Response

No response schema
delete

Delete favorites

Path parameters

  • idstring

    ID of the favorite

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/favorites/deleted/:id

Response

No response schema