Customers API Reference
API Reference/Customers

Customers

For authentication instructions, see API overview.

Endpoints

get/api/v2/customers
post/api/v2/customers
get/api/v2/customers/:id
put/api/v2/customers/:id
patch/api/v2/customers/:id
delete/api/v2/customers/:id
get

List all customers

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

Response

No response schema
post

Create customer

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

Request body

  • isCompanyboolean
  • capitalinteger
  • managerstring
  • namestring
  • name_arstring
  • address_arstring
  • street1string
  • street2string
  • zipCodestring
  • citystring
  • contactsarray
  • siretstring
  • rcsstring
  • unNumberinteger
  • statusstring
  • subjectstring
  • categorystring

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/customers \
	-d 'isCompany="boolean"' \
	-d 'capital=2000000' \
	-d 'manager="string"' \
	-d 'name="string"' \
	-d 'name_ar="string"' \
	-d 'address_ar="string"' \
	-d 'street1="string"' \
	-d 'street2="string"' \
	-d 'zipCode="string"' \
	-d 'city="string"' \
	-d 'contacts="array"' \
	-d 'siret="string"' \
	-d 'rcs="string"' \
	-d 'unNumber="integer"' \
	-d 'status="string"' \
	-d 'subject="string"' \
	-d 'category="string"'

Response

No response schema
get

Retrieve customer

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

Path parameters

  • idstring

    ID of the customer

Request

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

Response

No response schema
put

Update customer

Path parameters

  • idstring

    ID of the customer

Request body

  • isCompanyboolean
  • capitalinteger
  • managerstring
  • namestring
  • name_arstring
  • address_arstring
  • street1string
  • street2string
  • zipCodestring
  • citystring
  • contactsarray
  • siretstring
  • rcsstring
  • unNumberinteger
  • statusstring
  • subjectstring
  • categorystring

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/customers/:id \
	-d 'isCompany="boolean"' \
	-d 'capital=2000000' \
	-d 'manager="string"' \
	-d 'name="string"' \
	-d 'name_ar="string"' \
	-d 'address_ar="string"' \
	-d 'street1="string"' \
	-d 'street2="string"' \
	-d 'zipCode="string"' \
	-d 'city="string"' \
	-d 'contacts="array"' \
	-d 'siret="string"' \
	-d 'rcs="string"' \
	-d 'unNumber="integer"' \
	-d 'status="string"' \
	-d 'subject="string"' \
	-d 'category="string"'

Response

No response schema
patch

Update customer soft

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

Path parameters

  • idstring

    ID of the customer

Request

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

Response

No response schema
delete

Delete customer

Path parameters

  • idstring

    ID of the customer

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/customers/:id

Response

No response schema