API Documentation

GET /contacts

List Contacts

Retrieves a list of contacts associated to an account. The account is determined by the API key.

  • Pagination is done using “page” parameter.
  • The amount of results returned for each page can be set by the “size” parameter.

Resource URL

GET https://api.prodpad.com/v1/contacts

Parameters

page optional The page of results to retrieve. The number of results per page can be set by the “size” parameter.
size optional The number of results per page
tags optional URL encoded comma separated list of tag names. The available tags can be fetched using GET /tags endpoint
persona optional URL encoded name of a persona for the account. The available personas can be fetched using GET /personas endpoint
company optional URL encoded id of the company. The available companies can be fetched using GET /companies endpoint
job_role optional URL encoded name or id of job roles. The available job roles can be fetched using GET /job_roles endpoint
feedbacks optional Set to "true" and the response will include the feedback associated to the contacts. Default is false

Response

Contacts without their feedback included

Status: 200 OK
{
"success": true,
"contact_count": "3",
"page": 1,
"size": 100,
"filters": {
"tags": null,
"persona": null,
"company": null,
"job_role": null
},
"include": {
"feedbacks": false,
"numeric_id": false
},
"contacts": [
{
"id": "d75a76ab-e59f-499c-852c-fb9bee46bb43",
"name": "Colin Customer",
"email": "customer123@company.com",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"job_role": null,
"company": {
"id": "60e320c0-fd57-11e8-83b5-613eacb56de6",
"name": "Big Company",
"city": null,
"country": null,
"size": "10000",
"value": "Large",
"image_url": null,
"created_at": "2018-12-11 15:13:56",
"updated_at": "2019-01-02 13:30:57"
},
"tags": [
{
"id": "56533",
"tag": "High Value",
"added": "2019-01-02 13:45:37"
},
{
"id": "33242",
"tag": "Tech",
"added": "2019-01-02 13:45:37"
},
{
"id": "45456",
"tag": "Revenue",
"added": "2019-01-02 13:45:37"
}
],
"personas": [
{
"id": 34454,
"persona": "Rage Click Roger",
"added": "2019-01-02 13:45:37"
},
{
"id": 23432,
"persona": "PM Pamela",
"added": "2019-01-02 13:45:37"
},
{
"id": 35235,
"persona": "Mobile Manesh",
"added": "2019-01-02 13:45:38"
}
],
"external_links": [
{
"id": 76578,
"name": "",
"url": "http://www.acompany.com",
"added": "2019-03-07 15:50:54"
},
{
"id": "0664fbac-4202-48e8-9ba7-d3ce0e56075e",
"name": "Celia Client",
"email": "customer456@anothercompany.com",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"job_role": null,
"company": null,
"tags": [
{
"id": "56533",
"tag": "High Value",
"added": "2019-01-02 13:45:37"
},
{
"id": "45456",
"tag": "Revenue",
"added": "2019-01-02 13:45:37"
}
],
"personas": [
{
"id": 34454,
"persona": "Rage Click Roger",
"added": "2019-01-02 13:45:37"
},
{
"id": 23432,
"persona": "PM Pamela",
"added": "2019-01-02 13:45:37"
},
{
"id": 35235,
"persona": "Mobile Manesh",
"added": "2019-01-02 13:45:38"
}
],
"external_links": [],
"created_at": "2018-10-22 11:08:07",
"updated_at": "2019-01-02 13:45:26"
}
],
"external_links": [
{
"id": 76578,
"name": "",
"url": "http://www.anothercompany.com",
"added": "2019-03-07 15:50:54"
},
{
"id": "1e96d6ab-c557-43f2-9aac-0061b1825636",
"name": "Caroline Contact",
"email": "",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"job_role": null,
"company": {
"id": "e45d0bd7-1644-41de-b706-a77ff83a8367",
"name": "Another Big Company",
"city": null,
"country": null,
"size": "10000",
"value": "Large",
"image_url": null,
"created_at": "2018-12-11 15:13:56",
"updated_at": "2019-01-02 13:30:57"
},
"tags": [
{
"id": "56533",
"tag": "High Value",
"added": "2019-01-02 13:45:37"
}
],
"personas": [
{
"id": 34454,
"persona": "Rage Click Roger",
"added": "2019-01-02 13:45:37"
},
{
"id": 35235,
"persona": "Mobile Manesh",
"added": "2019-01-02 13:45:38"
}
],
"external_links": [
{
"id": 76578,
"name": "",
"url": "http://www.acompany.com",
"added": "2019-03-07 15:50:54"
}
}

 

Contacts with feedback included

Status: 200 OK
{
"success": true,
"contact_count": "3",
"page": 1,
"size": 100,
"filters": {
"tags": null,
"persona": null,
"company": null,
"job_role": null
},
"include": {
"feedbacks": false,
"numeric_id": false
},
"contacts": [
{
"id": "d75a76ab-e59f-499c-852c-fb9bee46bb43",
"name": "Colin Customer",
"email": "customer123@company.com",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"job_role": null,
"company": {
"id": "60e320c0-fd57-11e8-83b5-613eacb56de6",
"name": "Big Company",
"city": null,
"country": null,
"size": "10000",
"value": "Large",
"image_url": null,
"created_at": "2018-12-11 15:13:56",
"updated_at": "2019-01-02 13:30:57"
},
"tags": [
{
"id": "56533",
"tag": "High Value",
"added": "2019-01-02 13:45:37"
},
{
"id": "33242",
"tag": "Tech",
"added": "2019-01-02 13:45:37"
},
{
"id": "45456",
"tag": "Revenue",
"added": "2019-01-02 13:45:37"
}
],
"personas": [
{
"id": 34454,
"persona": "Rage Click Roger",
"added": "2019-01-02 13:45:37"
},
{
"id": 23432,
"persona": "PM Pamela",
"added": "2019-01-02 13:45:37"
},
{
"id": 35235,
"persona": "Mobile Manesh",
"added": "2019-01-02 13:45:38"
}
],
"external_links": [
{
"id": 76578,
"name": "",
"url": "http://www.acompany.com",
"added": "2019-03-07 15:50:54"
},
"feedbacks": [
{
"id": 67567,
"feedback": "<ol><li><h1>Support autosuggest for placing ideas on a roadmap</h1></li><li><div>From the roadmap view, allow users to add ideas using auto-suggest to select an idea from ideas list.</div></li></ol>",
"source": "api",
"state": "active",
"created_at": "2014-01-21 19:11:51",
"updated_at": "2017-06-23 13:01:31"
},
{
"id": 69778,
"feedback": "Lets not forget to add Å,å,Æ,æ,Ø,ø as well as Å,å,Ä,ä,Ö,ö",
"source": "api",
"state": "active",
"created_at": "2014-04-12 16:53:02",
"updated_at": "2016-10-25 15:37:45"
}
]
},
{
"id": "0664fbac-4202-48e8-9ba7-d3ce0e56075e",
"name": "Celia Client",
"email": "customer456@anothercompany.com",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"job_role": null,
"company": null,
"tags": [
{
"id": "56533",
"tag": "High Value",
"added": "2019-01-02 13:45:37"
},
{
"id": "45456",
"tag": "Revenue",
"added": "2019-01-02 13:45:37"
}
],
"personas": [
{
"id": 34454,
"persona": "Rage Click Roger",
"added": "2019-01-02 13:45:37"
},
{
"id": 23432,
"persona": "PM Pamela",
"added": "2019-01-02 13:45:37"
},
{
"id": 35235,
"persona": "Mobile Manesh",
"added": "2019-01-02 13:45:38"
}
],
"external_links": [],
"created_at": "2018-10-22 11:08:07",
"updated_at": "2019-01-02 13:45:26"
}
],
"external_links": [
{
"id": 76578,
"name": "",
"url": "http://www.anothercompany.com",
"added": "2019-03-07 15:50:54"
},
"feedbacks": [
{
"id": 67384,
"feedback": "I'd like more of the things but less of the stuff",
"source": "api",
"state": "active",
"created_at": "2014-02-21 20:51:51",
"updated_at": "2017-06-23 15:01:25"
}
]
},
{
"id": "1e96d6ab-c557-43f2-9aac-0061b1825636",
"name": "Caroline Contact",
"email": "",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"job_role": null,
"company": {
"id": "e45d0bd7-1644-41de-b706-a77ff83a8367",
"name": "Another Big Company",
"city": null,
"country": null,
"size": "10000",
"value": "Large",
"image_url": null,
"created_at": "2018-12-11 15:13:56",
"updated_at": "2019-01-02 13:30:57"
},
"tags": [
{
"id": "56533",
"tag": "High Value",
"added": "2019-01-02 13:45:37"
}
],
"personas": [
{
"id": 34454,
"persona": "Rage Click Roger",
"added": "2019-01-02 13:45:37"
},
{
"id": 35235,
"persona": "Mobile Manesh",
"added": "2019-01-02 13:45:38"
}
],
"external_links": [
{
"id": 76578,
"name": "",
"url": "http://www.acompany.com",
"added": "2019-03-07 15:50:54"
}
"feedbacks": [
{
"id": 67984,
"feedback": "This, but as a mobile app",
"source": "api",
"state": "active",
"created_at": "2015-03-21 21:31:59",
"updated_at": "2018-09-23 17:11:25"
}
]
}
}

Notes

  • All dates are in UTC
  • The text fields can include HTML markup

Comments