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 premium 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

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned
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

With feedbacks parameter set to true

With contacts parameter set to true

Notes

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

Get a Single Company

Retrieve a single company record associated to an account. The account is determined by the API key.

Resource URL

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

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned
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

With feedbacks parameter set to true

With contacts parameter set to true

Notes

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

 

 

 

Have more questions? Submit a request

Comments