Customers
List
Get a paginated list of customers
GET https://api.deskero.com/customer/list
Headers
Header |
Value |
Authorization |
Bearer {{bearer}} |
Accept |
application/json |
clientId |
{{clientId}} |
URL parameters
Field name |
Value |
Required |
Default |
page |
int value for page to show |
False |
1 |
Example request
$ curl https://api.deskero.com/customer/list \
-v \
-H "Accept: application/json" \
-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
-H "clientId: 51f01687e4b094c81d7b8bcdellef"
Example response
{
"customer": {
"totalRecords": 50,
"recordsPerPage": 25,
"previousQuery": null,
"nextQuery": "https://api.deskero.com/customer/list?page=2",
"records": [
See customer detail
]
}
}
Search
Search a customer
GET https://api.deskero.com/customer/list
Headers
Header |
Value |
Authorization |
Bearer {{bearer}} |
Accept |
application/json |
clientId |
{{clientId}} |
URL parameters
Field name |
Value |
Required |
Default |
page |
int value for page to show |
False |
1 |
{{fieldName}} |
a value to search |
False |
|
Example request
$ curl https://api.deskero.com/customer/list?name=Frank Elvgren\
-v \
-H "Accept: application/json" \
-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
-H "clientId: 51f01687e4b094c81d7b8bcdellef"
Example response
{
"customer": {
"totalRecords": 1,
"recordsPerPage": 25,
"previousQuery": null,
"nextQuery": null,
"records": [
See customer detail
]
}
}
Detail
Show a single customer
GET https://api.deskero.com/customer/{{customerId}}
Headers
Header |
Value |
Authorization |
Bearer {{bearer}} |
Accept |
application/json |
clientId |
{{clientId}} |
Example request
$ curl https://api.deskero.com/customer/527a0f95e4b0d3bd74d43929 \
-v \
-H "Accept: application/json" \
-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
-H "clientId: 51f01687e4b094c81d7b8bcdellef"
Example response
{
"id": "527a0f95e4b0d3bd74d43929",
"name": "Frank Elvgren",
"birthDate": -72748800000,
"email": "frankelvgren@myemail.com",
"phoneNumber": "202-555-0187",
"faxNumber": "202-555-0103",
"mobileNumber": "07700 900595",
"address": "4-5 Gough Square",
"city": "London",
"province": null,
"state": "GB",
"postalNumber": "EC4A 3DE",
"skypeAddress": "frank.elvgren",
"msnAddress": "frank67elvgren@hotmail.com",
"gtalkAddress": null,
"twitterAccountUrl": null,
"facebookAccountUrl": null,
"linkedinAccountUrl": null,
"googleAccountUrl": null,
"youtubeAccountUrl": null,
"registrationChannel": "STANDARD",
"topClient": true,
"profilePhotoUrl": "https://api.deskero.com/customer/photo/527a0f95e4b0d3bd74d43929",
"profilePhotoBlob": null,
"signature": "Regards, Frank Elvgren",
"memo": "a great customer",
"website": null,
"company": null,
"language": "en",
"account": {
See account detail
},
"insertByAgentId": null,
"customFields": null
}
Create
Create a new customer
POST https://api.deskero.com/customer/insert
Headers
Header |
Value |
Authorization |
Bearer {{bearer}} |
Content-Type |
application/json |
clientId |
{{clientId}} |
Example request
$ curl https://api.deskero.com/customer/insert \
-v \
-H "Content-type: application/json" \
-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
-X POST \
-d '{ "name": "Customer Name", "email": "customer@email.com" }'
Example response
Created customer id
{
"id": "527a0f95e4b0d3bd74d43929"
}
Update
Update a customer
PUT https://api.deskero.com/customer/update/{{customerId}}
Headers
Header |
Value |
Authorization |
Bearer {{bearer}} |
Content-Type |
application/json |
clientId |
{{clientId}} |
Example request
$ curl https://api.deskero.com/customer/update/527a0f95e4b0d3bd74d43929 \
-v \
-H "Content-type: application/json" \
-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
-X PUT \
-d '{ "name": "Customer Name", "email": "customer@email.com" }'
Example response
Updated customer id
{
"id": "527a0f95e4b0d3bd74d43929"
}
Delete
Delete a customer
DELETE https://api.deskero.com/customer/delete/{{customerId}}
Headers
Header |
Value |
Authorization |
Bearer {{bearer}} |
Content-Type |
application/json |
clientId |
{{clientId}} |
Example request
$ curl https://api.deskero.com/customer/delete/527a0f95e4b0d3bd74d43929 \
-v \
-H "Content-type: application/json" \
-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
-X DELETE
Example response
Deleted customer id
{
"id": "527a0f95e4b0d3bd74d43929"
}
Fields
Field name |
Description |
id |
auto-generated customer id |
name |
full name |
birthDate |
birth date timestamp |
phoneNumber |
phone number string |
faxNumber |
fax number string |
mobileNumber |
mobile number string |
address |
full address |
city |
city |
province |
province |
state |
two chars iso country code, for example GB |
postalNumber |
postal number string |
skypeAddress |
account skype |
msnAddress |
account msn |
gtalkAddress |
account gtalk |
twitterAccountUrl |
twitter account url |
facebookAccountUrl |
facebook account url |
linkedinAccountUrl |
linkedin account url |
googleAccountUrl |
google plus account url |
youtubeAccountUrl |
youtube plus account url |
registrationChannel |
customer source |
topClient |
preferred customer as boolean |
profilePhotoUrl |
auto-generated photo url, for example https://api.deskero.com/customer/photo/527a0f95e4b0d3bd74d43929 |
profilePhotoBlob |
blog to upload photo |
signature |
customer signature for tickets and replies |
memo |
internal note |
website |
website url |
company |
company name |
language |
language (en,it,es,fr) for ui and emails |
account |
object with user credentials, see account detail |
insertByAgentId |
id of agent that created the customer |
customFields |
object with custom fields, see custom field detail |