GET /contacts

List Contacts

Retrieves a list of ideas 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/ideas

Parameters

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

Contacts with feedback included

Notes

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

 

Get a Single Contact

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

Resource URL

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

Parameters

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 the feedback associated to the contact. Default is false

Response

Get a contact without any feedback

GET /contacts/[contact id]?apikey=[some key]

Get a contact with feedback

GET /contacts/[contact id]?apikey=[some key]&feedbacks=true

Notes

  • All dates are in UTC
  • The text fields can include HTML markup
Have more questions? Submit a request

Comments