Customers

Customers

For instructions on how to authenticate to use this endpoint, see API overview.

Retrieve undefined

Request

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

Response

No response

Create undefined

Request Parameters

  • isCompany
    boolean
  • capital
    integer
  • manager
    string
  • name
    string
  • name_ar
    string
  • address_ar
    string
  • street1
    string
  • street2
    string
  • zipCode
    string
  • city
    string
  • contacts
    array
  • siret
    string
  • rcs
    string
  • unNumber
    integer
  • status
    string
  • subject
    string
  • category
    string

Request

POST /customers
export ICLOUDREADY_API_KEY=[your api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/customers\
	-d isCompany="boolean"

Response

No response

Retrieve undefined

Path Parameters

  • id
    string

    ID of the customer

Request

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

Response

No response

Update undefined

Path Parameters

  • id
    string

    ID of the customer

Request

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

Response

No response

Update undefined

Path Parameters

  • id
    string

    ID of the customer

Request

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

Response

No response

Delete undefined

Path Parameters

  • id
    string

    ID of the customer

Request

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

Response

No response

Questions?

Was this page useful?