Custom API Reference
API Reference/Custom

Custom

For authentication instructions, see API overview.

Endpoints

get/api/v2/customFields/objects
get/api/v2/customFields/:object
post/api/v2/customFields/:object
put/api/v2/customFields/:object/:fieldId
delete/api/v2/customFields/:object/:fieldId
get

List all custom fields objects

Returns a list of custom fields objects. The custom fields 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/customFields/objects

Response

No response schema
get

List all custom fields

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

Path parameters

  • objectstring

    Object of the custom fields

Request

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

Response

No response schema
post

Create custom fields

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

Path parameters

  • objectstring

    Object of the custom fields

Request body

  • namestring
  • typestring
  • valuesarray
  • label1string
  • requiredboolean
  • visibleboolean
  • xPosnumber
  • yPosnumber
  • iconstring
  • placeholderstring

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/customFields/:object \
	-d 'name="field1"' \
	-d 'type="type1"' \
	-d 'values="array"' \
	-d 'label1="label1"' \
	-d 'required=true' \
	-d 'visible=true' \
	-d 'xPos=1' \
	-d 'yPos=1' \
	-d 'icon="icon1"' \
	-d 'placeholder="placeholder1"'

Response

No response schema
put

Update custom fields

Path parameters

  • objectstring

    Object of the custom fields

  • fieldIdstring

    ID of the custom field

Request body

  • namestring
  • typestring
  • valuesarray
  • label1string
  • requiredboolean
  • visibleboolean
  • xPosnumber
  • yPosnumber
  • iconstring
  • placeholderstring

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/customFields/:object/:fieldId \
	-d 'name="field1"' \
	-d 'type="type1"' \
	-d 'values="array"' \
	-d 'label1="label1"' \
	-d 'required=true' \
	-d 'visible=true' \
	-d 'xPos=1' \
	-d 'yPos=1' \
	-d 'icon="icon1"' \
	-d 'placeholder="placeholder1"'

Response

No response schema
delete

Delete custom fields

Path parameters

  • objectstring

    Object of the custom fields

  • fieldIdstring

    ID of the custom field

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/customFields/:object/:fieldId

Response

No response schema