API Reference/Salesmen

Salesmen

For authentication instructions, see API overview.

Endpoints

get/api/v2/salesmen

post/api/v2/salesmen

get/api/v2/salesmen/:id

put/api/v2/salesmen/:id

delete/api/v2/salesmen/:id

get

List all salesmen

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

Response

No response schema

post

Create salesmen

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

Request body

namestring
managerIdstring
addressstring
contactsarray
commissionPernumber

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/salesmen \
	-d 'name="Ahmed"' \
	-d 'managerId="609a8f85c2834915d0a5a5e9"' \
	-d 'address="address test"' \
	-d 'contacts="array"' \
	-d 'commissionPer=10'

Response

No response schema

get

Retrieve salesmen

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

Path parameters

idstring
ID of the salesman

Request

cURL

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

Response

No response schema

put

Update salesmen

Path parameters

idstring
ID of the salesman

Request body

namestring
managerIdstring
addressstring
contactsarray
commissionPernumber

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/salesmen/:id \
	-d 'name="Ahmed"' \
	-d 'managerId="609a8f85c2834915d0a5a5e9"' \
	-d 'address="address test"' \
	-d 'contacts="array"' \
	-d 'commissionPer=10'

Response

No response schema

delete

Delete salesmen

Path parameters

idstring
ID of the salesman

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

Response

No response schema