API Documentation

GET /companies

List Companies

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

  • Pagination is done using “page” parameter.
  • 100 results are returned for each page

NOTE: This endpoint is only available for Advanced or higher subscriptions. If you have a standard or lower, the API will return a 403 status code.

Resource URL

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

Parameters

page optional Page of results that should be returned. Each page has a 100 entries.
tags optional URL encoded comma separated list of tag names. The available tags can be fetched using GET /tags endpoint.
size optional URL encoded size of company to filter the list by. The available sizes are 1_10, 11_50, 50_250, 250_500, 500_1000, 1000_5000, 5000_10000, 10000.
value optional URL encoded value of the company to you. The available values are "high", "medium" and "low".
country optional URL encoded ISO Alpha-2 country code.
city optional URL encoded city name.
feedbacks optional Set to "true" and the response will include contacts associated to the companies along with their feedback. Default is false.
contacts optional Set to "true" and the response will include the contacts associated with the companies. Default is false.

Response

Without feedbacks or contacts parameters

Status: 200 OK
{
"success": true,
"company_count": 3,
"page": 1,
"size": 3,
"filters": {
"tags": null,
"size": null,
"value": null,
"country": null,
"city": null
},
"include": {
"feedbacks": false,
"contacts": false
},
"companies": [
{
"id": "be9f4044-184a-40a4-8326-24942119c1b9",
"name": "Frank\n",
"city": "Brighton",
"country": "GB",
"size": "11_50",
"value": "high",
"image": null,
"tags": [
{
"id": "23423",
"tag": "A tag",
"added": "2017-06-23 14:18:22"
}
],
"external_links": [
{
"id": 12341,
"name": "",
"url": "http://www.google.com",
"added": "2017-06-23 14:18:32"
}
],
"created_at": "2017-05-19 13:19:27",
"updated_at": "2017-07-27 14:49:59"
},
{
"id": "4545f8f6-ce4b-4466-84f4-44f608f58c7a",
"name": "Makalu",
"city": "New York",
"country": "US",
"size": null,
"value": null,
"image": null,
"tags": [],
"external_links": [
{
"id": 52343,
"name": "",
"url": "http://www.example.com",
"added": "2017-05-31 10:13:41"
}
],
"created_at": "2017-05-26 07:14:33",
"updated_at": "2017-05-31 10:20:17"
},
{
"id": "18358d00-df43-4916-b3e4-14291167fcf9",
"name": "Purple feedback",
"city": "London",
"country": "GB",
"size": "5000_10000",
"value": "high",
"image": null,
"tags": [
{
"id": "83742",
"tag": "AREV",
"added": "2017-05-30 10:26:31"
}
],
"external_links": [],
"created_at": "2017-05-30 10:19:52",
"updated_at": "2017-05-30 10:36:20"
}
]
}

 

With feedbacks parameter set to true

Status: 200 OK
{
"success": true,
"company_count": 3,
"page": 1,
"size": 3,
"filters": {
"tags": null,
"size": null,
"value": null,
"country": null,
"city": null
},
"include": {
"feedbacks": true,
"contacts": true
},
"companies": [
{
"id": "44647b0f-265c-48b1-a6e9-eb3882dbafa0",
"name": "Frank\n",
"city": "Brighton",
"country": "AW",
"size": "11_50",
"value": "high",
"image": null,
"tags": [
{
"id": "23452",
"tag": "Revenue",
"added": "2017-06-23 14:18:22"
}
],
"external_links": [
{
"id": 12343,
"name": "",
"url": "http://www.google.com",
"added": "2017-06-23 14:18:32"
}
],
"created_at": "2017-05-19 13:19:27",
"updated_at": "2017-07-27 14:49:59",
"contacts": [
{
"id": "34523",
"name": "Carol Customer",
"email": "customer@example.co.net",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"created_at": "2015-09-28 14:53:33",
"updated_at": "2017-06-01 08:45:15",
"feedbacks": [
{
"id": 64346,
"feedback": "More stuff",
"source": "api",
"state": "active",
"created_at": "2015-10-11 14:46:40",
"updated_at": "2015-10-11 14:46:40"
},
{
"id": 34522,
"feedback": "Less things",
"source": "api",
"state": "active",
"created_at": "2015-10-11 14:46:59",
"updated_at": "2015-10-11 14:46:59"
},
{
"id": 23453,
"feedback": "Will this work in adding customer feedback?",
"source": "api",
"state": "active",
"created_at": "2015-10-11 14:49:42",
"updated_at": "2015-10-11 14:49:42"
}
]
},
{
"id": "34542",
"name": "Sally Someone",
"email": "Something@example.net",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"created_at": "2016-02-24 08:55:47",
"updated_at": "2017-06-01 08:45:15",
"feedbacks": [
{
"id": 76566,
"feedback": "Here's a bit of feedback",
"source": "api",
"state": "active",
"created_at": "2016-02-24 08:55:47",
"updated_at": "2016-02-24 08:55:47"
}
]
}
]
},
{
"id": "a350ae1f-b8e4-4b6a-bcc2-243358be2cce",
"name": "Purple feedback",
"city": "London",
"country": "GB",
"size": "5000_10000",
"value": "high",
"image": null,
"tags": [
{
"id": "76657",
"tag": "High Value",
"added": "2017-05-30 10:26:31"
}
],
"external_links": [],
"created_at": "2017-05-30 10:19:52",
"updated_at": "2017-05-30 10:36:20",
"contacts": [
{
"id": "767898",
"name": "Aaron Bealsie",
"email": "ab@@example.net",
"about": "This is something about him!",
"phone": null,
"twitter_url": null,
"image": null,
"created_at": "2017-03-23 10:29:34",
"updated_at": "2017-07-26 13:14:00",
"feedbacks": [
{
"id": 76778,
"feedback": "More Things",
"source": "api",
"state": "active",
"created_at": "2017-03-23 10:29:34",
"updated_at": "2017-03-23 10:29:34"
},
{
"id": 13241,
"feedback": "Less Stuff!",
"source": "api",
"state": "active",
"created_at": "2017-03-23 10:42:36",
"updated_at": "2017-03-23 10:46:59"
}
]
}
]
}
}

 

With contacts parameter set to true

Status: 200 OK
{
"success": true,
"company_count": 3,
"page": 1,
"size": 3,
"filters": {
"tags": null,
"size": null,
"value": null,
"country": null,
"city": null
},
"include": {
"feedbacks": false,
"contacts": true
},
"companies": [
{
"id": "44647b0f-265c-48b1-a6e9-eb3882dbafa0",
"name": "Frank\n",
"city": "Brighton",
"country": "AW",
"size": "11_50",
"value": "high",
"image": null,
"tags": [
{
"id": "23452",
"tag": "Revenue",
"added": "2017-06-23 14:18:22"
}
],
"external_links": [
{
"id": 12343,
"name": "",
"url": "http://www.google.com",
"added": "2017-06-23 14:18:32"
}
],
"created_at": "2017-05-19 13:19:27",
"updated_at": "2017-07-27 14:49:59",
"contacts": [
{
"id": "34523",
"name": "Carol Customer",
"email": "customer@example.co.net",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"created_at": "2015-09-28 14:53:33",
"updated_at": "2017-06-01 08:45:15"
},
{
"id": "34542",
"name": "Sally Someone",
"email": "Something@example.net",
"about": "",
"phone": null,
"twitter_url": null,
"image": null,
"created_at": "2016-02-24 08:55:47",
"updated_at": "2017-06-01 08:45:15"
},
{
"id": "a350ae1f-b8e4-4b6a-bcc2-243358be2cce",
"name": "Purple feedback",
"city": "London",
"country": "GB",
"size": "5000_10000",
"value": "high",
"image": null,
"tags": [
{
"id": "76657",
"tag": "High Value",
"added": "2017-05-30 10:26:31"
}
],
"external_links": [],
"created_at": "2017-05-30 10:19:52",
"updated_at": "2017-05-30 10:36:20",
"contacts": [
{
"id": "767898",
"name": "Aaron Bealsie",
"email": "ab@@example.net",
"about": "This is something about him!",
"phone": null,
"twitter_url": null,
"image": null,
"created_at": "2017-03-23 10:29:34",
"updated_at": "2017-07-26 13:14:00",
}
]
}
}

Notes

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

 

Comments