Lookup API Reference
API Reference/Lookup

Lookup

For authentication instructions, see API overview.

Endpoints

get/api/v2/lookupobjects
post/api/v2/lookupobjects
get/api/v2/lookupobjects/:id
put/api/v2/lookupobjects/:id
patch/api/v2/lookupobjects/:id
delete/api/v2/lookupobjects/deleted/:id
post/api/v2/migrate-lookupobjects
get

List all lookup objects

Returns a list of lookup objects. The lookup objects 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/lookupobjects

Response

No response schema
post

Create lookup objects

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

Request body

  • modulestring
  • lookupObjectNamestring
  • lookupCodestring
  • descriptionstring
  • activeboolean
  • notesstring
  • allowedObjectsarray

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/lookupobjects \
	-d 'module="CRM"' \
	-d 'lookupObjectName="lookup1"' \
	-d 'lookupCode="code1"' \
	-d 'description="description1"' \
	-d 'active=true' \
	-d 'notes="notes1"' \
	-d 'allowedObjects="array"'

Response

No response schema
get

Retrieve lookup objects

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

Path parameters

  • idstring

    ID of the lookup object

Request

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

Response

No response schema
put

Update lookup objects

Path parameters

  • idstring

    ID of the lookup object

Request body

  • modulestring
  • lookupObjectNamestring
  • lookupCodestring
  • descriptionstring
  • activeboolean
  • notesstring
  • allowedObjectsarray

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/lookupobjects/:id \
	-d 'module="CRM"' \
	-d 'lookupObjectName="lookup1"' \
	-d 'lookupCode="code1"' \
	-d 'description="description1"' \
	-d 'active=true' \
	-d 'notes="notes1"' \
	-d 'allowedObjects="array"'

Response

No response schema
patch

Update lookup objects soft

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

Path parameters

  • idstring

    ID of the lookup object

Request

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

Response

No response schema
delete

Delete lookup objects

Path parameters

  • idstring

    ID of the lookup object

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

Response

No response schema
post

Create migrate lookup

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

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/migrate-lookupobjects

Response

No response schema