End Point - Customers
customers api
api
Get All Customers
GET https://support.evantodesk.com/api/v1/customers
Sample response:
Status: 200 OK
[{
"cellPhone": "+1 123 4567 ",
"workNumber": "+1 111 123-4567",
"firstName": "Fred",
"twitterId": "evantodesk",
"lastName": "Flintstone",
"notes": "A great guy",
"companyName": "Flint Ltd",
"userId": 123,
"zipCode": "10000BC",
"profileUrl": "",
"linkedInUrl": "",
"emailAddress": "fred@flintstone.com",
"companyId": 1,
"jobTitle": "Caveman",
"address": "Jurassic Park"
}]
Find a Customer by Email Address
GET https://support.evantodesk.com/api/v1/customers?email={{email}}
Sample response:
Status: 200 OK
[{
"cellPhone": "+1 123 4567 ",
"workNumber": "+1 111 123-4567",
"firstName": "Fred",
"twitterId": "evantodesk",
"lastName": "Flintstone",
"notes": "A great guy",
"companyName": "Flint Ltd",
"userId": 123,
"zipCode": "10000BC",
"profileUrl": "",
"linkedInUrl": "",
"emailAddress": "fred@flintstone.com",
"companyId": 1,
"jobTitle": "Caveman",
"address": "Jurassic Park"
}]
Find a Customer by UserId
GET https://support.evantodesk.com/api/v1/customers?userid={{userId}}
Sample response:
Status: 200 OK
[{
"cellPhone": "+1 123 4567 ",
"workNumber": "+1 111 123-4567",
"firstName": "Fred",
"twitterId": "evantodesk",
"lastName": "Flintstone",
"notes": "A great guy",
"companyName": "Flint Ltd",
"userId": 123,
"zipCode": "10000BC",
"profileUrl": "",
"linkedInUrl": "",
"emailAddress": "fred@flintstone.com",
"companyId": 1,
"jobTitle": "Caveman",
"address": "Jurassic Park"
}]
Create a New Customer
POST https://support.evantodesk.com/api/v1/customers
Parameters:
| Name | Type | Required | Description |
| email | string | Yes | email address |
| firstName | string | No | first name |
| lastName | string | No | last name |
| companyName | string | No | company name |
| workNumber | string | No | work phone number |
| cell | string | No | cell phone number |
| linkedInUrl | string | No | url of their LinkedIn profile |
| jobTitle | string | No | job title |
| address | string | No | postal address |
| twitterId | string | No | their Twitter Id |
| notes | string | No | any notes |
Sample response:
Status: 201 Created
[{
"cellPhone": "+1 123 4567 ",
"workNumber": "+1 111 123-4567",
"firstName": "Fred",
"twitterId": "evantodesk",
"lastName": "Flintstone",
"notes": "A great guy",
"companyName": "Flint Ltd",
"userId": 123,
"zipCode": "10000BC",
"profileUrl": "",
"linkedInUrl": "",
"emailAddress": "fred@flintstone.com",
"companyId": 1,
"jobTitle": "Caveman",
"address": "Jurassic Park"
}]
Was this article useful?
Yes No