Download a copy of the API docs here.

Start

AUTHENTICATION

● To access the Klenty REST APIs, you need to have a Klenty account.

● API key can be generated from Klenty account, which will be used with every

request to the Klenty API.

● To obtain an API key, log into your Klenty account.

● Go to SETTINGS → USER PREFERENCES → Klenty API Key

● Click on the key icon to ‘Generate API Key’.

● Your ‘API Key’ will be generated.

URI PARAMETER:

All API request URLs start with

https://app.klenty.com/apis/v1/user/<username>/

In the above http request, username is an URI parameter.

QUERY PARAMETER:

Anything you give after '?' in the URI , are called query parameters.

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?listName=csvlist1

The above URI has one query parameter, list name.

API KEY:

All API requests require authentication. You need to provide your key in the HTTP

request header via the Key parameter.

API Name: x-api-key

DATA TYPES

● We use JSON as the primary data type.

● Content Type - JSON(application/json)

PUBLIC APIs

Get prospect detail by Email

This endpoint expects an email address, and will return an object containing details of that prospect.

HTTP REQUEST

GET

://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?Email=steve@tutecircle.com

RESPONSEhttps

  {

"Id" : "58df455871e0960b001f8c6b",

"Country" : "India",

"City" : "Chennai",

"CompanyPhone" : "030-22558899",

"CompanyEmail" : "steve@klenty.com",

"Email" : "steve@tutecircle.com",

"Phone" : "987456321",

"Title" : "Test ANalyst",

"CompanyDomain" : "klenty.com",

"Company" : "Klenty",

"Department" : "Testing",

"LastName" : "Maher",

"FirstName" : "Steve",

"FullName" : "Steve Maher",

"assignTo" : "hello@klenty.com"

}

Get Prospect status by Email

This endpoint expects an email address , and will return an object containing status of that prospect.

HTTP REQUEST

GET

https://app.klenty.com/apis/v1/user/HELLO@KLENTY.com/prospects/steve@tutecircle.com/status

RESPONSE

{

"cadenceStatus" : "No active cadence",

"prospectStatus" : "Not Contacted"

}

Get Company Cadences

This endpoint expects an email address of one of the team members, and will return an object containing all cadences of that team.

HTTP REQUEST

GET https://app.klenty.com/apis/v1/user/klenty2@gmail.com/cadences

RESPONSE

[

  "call test",

  "call 101",

  "tasks&mails",

  "Test",

  "cad 2 step",

  "cad one step",

  "cad 1 step",

  "cad 3 step",

  "bounce cadence check",

  "inbox check",

  "Calls",

  "Taskcheck",

]

Get User Cadences

This endpoint expects an username of the user as a input, and will return an object containing cadences of that username.

HTTP REQUEST

GET 

https://app.klenty.com/apis/v1/user/hello@klenty.com/cadences?username=test16@gmail.com

RESPONSE

[

  "one step task",

  "cad 3 step",

  "1 step cad",

  "cad 2 step",

  "werwer1",

  "Tasks"

]

Get Lists

This endpoint expects an email address of a user, and will return an object containing the lists created or imported by that user

HTTP REQUEST

GET https://app.klenty.com/apis/v1/user/hello@klenty.com/lists

RESPONSE

   {

"Id" : "5860bcb7ca84a10b00bff3c6",

"name": "default"

}

   {

"Id" : "58dcc484cda2d03206eebb79",

"name": "klenty"

}  

   {

"Id" : "58ddfa7fcda2d03206eee7d2",

"name": "listing1"

}

Get Prospect status by ID

This endpoint expects an object ID of a prospect , and will return an object containing the status of that prospect.

HTTP REQUEST

GET

 https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/589c78690d66820b0005ced5/status

RESPONSE

{

"cadenceStatus" : "No active cadence",

"prospectStatus" : "Not Contacted"

}

Get Prospect by List

HTTP REQUEST

GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?listName=default

RESPONSE

{

"Id" : "58be33942f86310b00105b01",

"Email" : "mail207@gmail.com",

"LastName" : "lastname118",

"FirstName" : "name118",

"FullName" : "name118 lastname118",

"assignTo" : "hello@klenty.com"

}

{

"Id" : "58be33942f86310b00105b02",

"Email" : "mail206@gmail.com",

"LastName" : "lastname117",

"FirstName" : "name117",

"FullName" : "name117 lastname117",

"assignTo" : "hello@klenty.com"

}

{

"Id" : "58c6a1fd99dc7e0b00ecaa6d",

"Email" : "hello@hello.com",

"LastName" : "lastname3",

"FirstName" : "fanme3",

"FullName" : "fanme3 lastname3",

"assignTo" : "hello@klenty.com"

}

{

"Id" : "58c6a1fd99dc7e0b00ecaa6e",

"Email" : "hello1@hello.com",

"Phone" : "+91-9513574560",

"LastName" : "lastname4",

"FirstName" : "fanme4",

"FullName" : "fanme4 lastname4",

"assignTo" : "hello@klenty.com"

}

Get Prospect details with Custom fields

HTTP REQUEST

GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?Email=steve@tutecircle.com&customFields=true

Create Prospects

This endpoint will create a prospect based on the input which is given as a JSON object.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects

INPUT :

{"Email":"hello@klenty.com",

 "FirstName":"Hello",

 "Phone":"951357654",

 "Company":"Klenty",

 "FullName":"Hello Klenty",

 "LastName":"Klenty",

 "MiddleName":"Test",

 "Department":"Testing",

 "CompanyDomain":"klenty.com",

 "CompanyURL":"www.klenty.com",

 "Title":"Tester",

 "Location":"Chennai, Area",

 "City":"Chennai",

 "Country":"India",

 "List":"list1",

 "Tags":"tag1"

}

Response

{

"Status" : true

}

Start Cadence

This endpoint expects a email address of the prospect and the cadence name as the input, to start a cadence for a prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/startCadence

INPUT : 

{

"Email" : "steve@tutecircle.com",

"cadenceName" : "Cadence1"

}

Response

{

"Status" : true

}

Stop Cadence

This endpoint expects a email address of the prospect as input, to stop the cadence for that prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/stopCadence

INPUT : 

{

"Email" : "steve@tutecircle.com"

}

Response

{

"Status" : true

}

Resume Cadence

This endpoint expects a email address of a prospect as input, to resume the cadence for that prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/sneha@tutecircle.com/cadences/resume

INPUT :

{

"Email" : "steve@tutecircle.com"

}

Response

{

"Status" : true

}

Stop Mails

This endpoint expects a email address of a prospect as input, to stop the mails from going out for that prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/stop

INPUT :

{

"Email" : "steve@tutecircle.com"

}

Response

{

"Status" : true

}

prospects

Unsubscribe Prospect

This endpoint expects a email address of a prospect as input, to change prospect status to unsubscribe and remove all scheduled mails to that prospect.

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com//unsubscribe

INPUT :

 {

"Email" : "steve@tutecircle.com"

}

Response

{

"Status" : true

}

Update Prospect

This endpoint will update a prospect based on the input which is given as a JSON object.

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/hello@klenty.com

INPUT : 

{

  "Email" : "hello1@klenty.com",

  "FirstName" : "Hello1",

"Phone" : "951357654",

  "Company" : "Klenty1",

  "FullName" : "Hello Klenty1",

  "LastName" : "Klenty1",

  "MiddleName" : "Test1", 

  "Department" : "Testing1",

  "CompanyDomain" : "klenty1.com",

  "CompanyURL" : "www.klenty1.com",

  "Title" : "Tester1",

  "Location" : "Chennai Area1",

  "City" : "Chennai1",

  "Country" : "India1",

“List” :          “list1”,
“Tags” : “tag1”

}

Response

{

"Status" : true

}

Cohort Metrics

This endpoint expects a start date, end date and the name of the cadence to give the the metric count with respect to that cadence.

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/dailyCohortMetrics

INPUT 

{

"startDate" : "2017-02-01T06:30:51Z",

"endDate" : "2017-03-20T06:30:51Z",

"cadenceName" : "cad one step"

}

Response

 "Mar 07": 

{

"In Cadence" : 0,

"Completed Without Reply" : 0,

"Manually Stopped" : 0,

"Unsubscribed" : 0,

"Bounced" : 1,

"Replied Stopped" : 0,

"Auto Reply Stopped" : 0,

"Task Stopped" : 0

}

{

"Mar 13": 

{

"In Cadence" : 2,

"Completed Without Reply" : 0,

"Manually Stopped" : 1,

"Unsubscribed" : 0,

"Bounced" : 0,

"Replied Stopped" : 0,

"Auto Reply Stopped" : 0,

"Task Stopped" : 0

}

Email Engagements

This endpoint expects a start date, end date and the name of the cadence to give the the email engagement count with respect to that cadence.

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/emailEngagments

INPUT 

{

"startDate" : "2017-02-01T06:30:51Z",

"endDate" : "2017-03-20T06:30:51Z",

"cadenceName" : "cad one step"

}

Response

{

"mailsSentCount" : 62,

"openedMailCount" : 35,

"clickedMailCount" : 13,

"repliedMailCount" : 0,

"bouncedMailCount" : 6,

"unsubscribedMailCount" : 0,

"totalOpenCount" : 49,

"totalReplyCount" : 34,

"totalClickCount" : 0

}

StepWise Metric Engagement

This endpoint expects a start date, end date and the name of the cadence to give the the stepwise metric count with respect to that cadence.

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/stepWiseEngagements

INPUT 

{

"startDate" : "2017-02-01T06:30:51Z",

"endDate" : "2017-03-20T06:30:51Z",

"cadenceName" : "cad one step"

}

Response

{

"stepNumber" : 1,

"stepType" : "mail",

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 1,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"options": [ 

        {

"Option" : 1,

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 1,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"Subject" : "welcome",

"templateName" : "welcome"

}

 

{

"Option" : 2,

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 0,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"Subject" : "followup pipe",

"templateName" : "followup pipe"

          } 

{

"Option" : 3,

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 0,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"Subject" : "calendly",

"templateName" : "calendly"

}

Add a Webhook

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/zapier/hooks

INPUT 

The JSON input can have either of the four events listed as the input.

      [

reply,

sendProspect,

startCadence,

completeCadence

]

{

"Subscription_url" : "wwww.test.com/xyz",

"Event" : "startCadence"

}

Response

{

"Event" : "startCadence",

"Url" : "wwww.test.com/xyz",

"_id" : "58df9cddbee1650b008214b6"

}

Add a List

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects

INPUT : 

{

  "Email" : "hello1@klenty.com",

  "FirstName" : "Hello1",

“List” : “list1”

}

Response

{

"Status" : true

}

Add  Tags

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects

INPUT : 

{

  "Email" : "hello1@klenty.com",

  "FirstName" : "Hello1",

“Tags” : “tag1”

}

For multiple tags       “Tags” :   “tag1|tag2”

Response

{

"Status" : true

}

Add  Custom Fields

HTTP REQUEST

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects

{

  "Email" : "hello1@klenty.com",

  "FirstName" : "Hello1",

“CustomFields” : [{“key”:”customfield1”, “value” : “value1”}, {“key”:”customfield2”, “value” : “value2”},...........................  ]

}

Response

{

"Status" : true

}

Get User Journeys

This endpoint expects an username of the user as a input, and will return an object containing journeys of that username.

HTTP REQUEST

GET 

https://app.klenty.com/apis/v1/user/hello@klenty.com/journeys?username=hello@klenty.com

RESPONSE

[

  “journey1”,

“journeytest2”

]

Get Company Journeys

This endpoint expects an email address of one of the team members, and will return an object containing all journeys of that team.

HTTP REQUEST

GET https://app.klenty.com/apis/v1/user/hello@klenty.com/Journeys

RESPONSE

  [

  “journey1”,

“journeytest2”,

“Test3”,
“test4”

]

Start Journeys

This endpoint expects a email address of the prospect and the journey name as the input, to start a journey for a prospect. To specify a start time for the Journey, use scheduledDate and provide the time in UTC. If scheduledDate is not provided, the Journey will be started immediately for the prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/journey/start

INPUT : 

{

"Email" : "steve@tutecircle.com",

"journeyName" : "journeytest2",

"scheduledDate" : "2017-02-01T06:30:51Z"

}

Response

{

"Status" : true

}

Resume Journeys

This endpoint expects a email address of a prospect as input, to resume the journey for that prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/journey/resume

INPUT :

{

"Email" : "steve@tutecircle.com"

}

Response

{

"Status" : true

}

Stop Journeys

This endpoint expects a email address of the prospect as input, to stop the journey for that prospect.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/klentyuser2@gmail.com/journey/stop

INPUT : 

{

"Email" : "steve@tutecircle.com"

}

Response

{

"Status" : true

}

Bulk Add Prospects

This endpoint will create less than 100 prospects based on the input which is given as a JSON object.

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects

INPUT :

 [{

    "Email":"raje7@klenty.com",

 "FirstName" : "Hello1",

 "Phone" : "951357654",

 "FullName" : "Hello Klenty1",

 "LastName" : "Klenty1",

 "MiddleName" : "Test1",

 "Department" : "Testing1",

 "CompanyDomain" : "klenty1.com",

 "CompanyURL" : "www.klenty1.com",

 "Title" : "Tester1",

 "Location" : "Chennai Area1",

 "City" : "Chennai1",

 "Country" : "India1",

"CustomFields" : [{"key":"krishnafascino", "value" : "value1"}]},

                    

 {

    "Email":"raeh8@klenty.com",

 "FirstName" : "Hello1",

 "Phone" : "951357654",

 "FullName" : "Hello Klenty1",

 "LastName" : "Klenty1",

 "MiddleName" : "Test1",

 "Department" : "Testing1",

 "CompanyDomain" : "klenty1.com",

 "CompanyURL" : "www.klenty1.com",

 "Title" : "Tester1",

 "Location" : "Chennai Area1",

 "City" : "Chennai1",

 "Country" : "India1"

 }

]

Response

{

"status": "Bulk Import started Successfully"

}

REMOVE TAGS

This endpoint will help you remove multiple or single tags linked with your prospect in klenty

HTTP REQUEST

POST https://app.klenty.com/apis/v1/user/klentyuser2@gmail.com/prospects/zoluk@apdepgir.bw/removeTags

INPUT :

{

  "tag" : ["1","2","tag1","tag2"]

}

Response:

{

"status": true

}

Did this answer your question?