General advice for using the ProsperWorks API

If you are curious about using the API, here is some general advice that might help:

If you want to call the API, please do it from the server side.
Whatever code is serving your local host is the one that needs to call the API. Since it is not a browser, it will not have the same security restrictions. More simply, you can use the https library and make an https.request to ProsperWorks.
For more information, I've included a link on the security measures I mentioned.
All API calls are limited to 600 requests every 10 minutes.
If you are trying to get back all results, you will have to specify page number and size.
Curious about how to request pages? View this Google sheets script example where we return related contacts with opportunities. 
Here is another Google sheets script example where we export all activity notes.
How to get open tasks and related people.
How to list all users.
Instructions: You can follow any of the instructions for the scripts above and it will work the same.
You can now search leads/people/companies for phone number:
curl -H "Content-Type: application/json" -X POST \
--header "X-PW-AccessToken:TOKEN" \
--header "X-PW-Application:developer_api" \
--header "X-PW-UserEmail:EMAIL" \ \
--data '{"phone_number":"4152223334"}'
You can also search leads by email address:
curl --request POST \
--header "Content-Type: application/json" \
--header "X-PW-AccessToken:TOKEN" \
--header "X-PW-Application:developer_api" \
--header "X-PW-UserEmail:EMAIL" \ \
--data '{"emails": "mylead@gmail.test"}'
You can search leads/people/companies/opportunities by full name:
curl --request POST \
--header "Content-Type: application/json" \
--header "X-PW-AccessToken:TOKEN" \
--header "X-PW-Application:developer_api" \
--header "X-PW-UserEmail:EMAIL" \ \
--data '{
"name": "Boram Jane Lee"
We now have webhooks!
We also have a community forum for developers. Feel free to share how you have been using our API:
Not sure how to use custom fields? Here is how to create a lead in node with custom fields:
Here is how to make a person in node:
Sample CURL request to make an opportunity
If you use node, here is a tutorial for your reference.
You should be able to get it working with the requests library. It might require an extra flag for json: true.
Don't want to code? Here are some automations that don't require coding:
If you have any questions around using our API, please make a request here.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Article is closed for comments.