{"info":{"_postman_id":"478d41a7-fdf8-48f7-b84a-a2ace8267531","name":"Winning Proposal - P(ublic) API documentation: V1","description":"

Compatible with Winning Proposal system versions:

9.*.*
\n
8.*.*
\n
7.*.*
\n
6.*.*
\n
5.*.*
\n
4.*.*
\n
3.*.*
\n

Introduction

The Public API of Winning Proposal is designed with flexibility and extensibility in mind. It follows RESTful principles and enables seamless interaction with our platform’s features.

This documentation provides an overview of all available endpoints, the required requests, and the expected responses.

Authentication & Security

Although the API is publicly accessible, all requests must be properly authenticated. Winning Proposal uses the Basic Authentication scheme to verify each request.

Constructing the Authorization Header

To access the API, every request must include an Authorization header containing a value based on your application's name and the provided client_secret.

Follow these steps to construct the header:

Concatenate your application name and client_secret using a semicolon (;):
application_name;client_secret
\n
Encode the resulting string in Base64.
\n
Prefix the encoded string with 'Basic ' (note the space).
\n
Add this full string as the value of the Authorization header in your request.
\n

Example:
Authorization: Basic YXBwbmF0aW9uX25hbWU7Y2xpZW50X3NlY3JldA==

\n $\"PHP%20example\"$ \n\n $\"Postman%20example\"$ \n\n

Access Requirements

To successfully perform an API call, the following requirements must be met:

The application must be registered within Winning Proposal (you will receive the name and client_secret).
\n
The application must be marked as active.
\n
API calls must originate from a whitelisted IP address.
\n
Each endpoint is protected by specific permissions.
\n

If any of these conditions are not met, the API will return an error with HTTP status code 401 (Unauthorized). Please contact us if you encounter such errors.

Remote id's

Some of the entities within Winning Proposal have a field called ‘remote_id’. This field can be used to store your own ID. This way you can indicate the relationship with entities in your own database.

StartFragment

Including Relationships in GET Requests

Many GET endpoints allow you to eager-load related entities using the with query parameter.

Use a comma (,) to include multiple relationships.
\n
Use a dot (.) to traverse nested relationships.
\n

For example:

GET /public/api/v1/prospects?with=prospectContacts

This will retrieve the entity along with its related client, the client's contact person.

The available relationships for each endpoint are listed in the parameter reference. Refer to the image below for an example of an eager-loaded response.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Authentication & Security","slug":"authentication-security"},{"content":"Remote id's","slug":"remote-ids"}],"owner":"4270458","collectionId":"478d41a7-fdf8-48f7-b84a-a2ace8267531","publishedId":"2sB2xBCpH2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-20T12:22:01.000Z"},"item":[{"name":"Prospects","item":[{"name":"Index","id":"0b542486-62b9-4d6f-9e98-25fb66a40aa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/public/v1/prospects/","description":"

Retrieves a list of prospects in Winning Proposal.

(optional) Filter by prospect_name_full.

\n","type":"text/plain"},"key":"prospect_name_full","value":""},{"disabled":true,"description":{"content":"

(optional) Filter by prospect_name_short.

\n","type":"text/plain"},"key":"prospect_name_short","value":""},{"disabled":true,"description":{"content":"

(optional) Filter by search_name.

\n","type":"text/plain"},"key":"search_name","value":""},{"disabled":true,"description":{"content":"

(optional) Filter by the ID of the user who owns this prospect.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

(optional) Filter on the ID of the branch to which this prospect is linked.

\n","type":"text/plain"},"key":"branch_id","value":""},{"disabled":true,"description":{"content":"

(optional) Filter on the email.

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

(optional) Filter on an ID/number from your system.

\n","type":"text/plain"},"key":"remote_id","value":""},{"disabled":true,"description":{"content":"

(optional) Filter on an ID/number from your system.

\n","type":"text/plain"},"key":"secondary_remote_id","value":""},{"disabled":true,"description":{"content":"

(optional) Partially searches for the given string in the fields:

prospect_name_full
prospect_name_short
tel
email
remote_id

\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"

(optional) Loads the related entities. The following possibilities, comma-seperated:

prospectContacts
addresses
branch

\n","type":"text/plain"},"key":"with","value":""}],"variable":[]}},"response":[{"id":"f21bbc02-745f-49c6-9473-d0d5af795964","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/public/v1/prospects/?prospect_name_full=Test Company Inc&with=prospectContacts,branch","host":[""],"path":["api","public","v1","prospects",""],"query":[{"key":"prospect_name_full","value":"Test Company Inc","description":"(optional) Filter by prospect_name_full."},{"key":"prospect_name_short","value":"","description":"(optional) Filter by prospect_name_short.","type":"text","disabled":true},{"key":"search_name","value":"","description":"(optional) Filter by search_name.","type":"text","disabled":true},{"key":"user_id","value":"","description":"(optional) Filter by the ID of the user who owns this prospect.","type":"text","disabled":true},{"key":"branch_id","value":"","description":"(optional) Filter on the ID of the branch to which this prospect is linked.","type":"text","disabled":true},{"key":"email","value":"","description":"(optional) Filter on the email.","type":"text","disabled":true},{"key":"remote_id","value":"","description":"(optional) Filter on an ID/number from your system.","type":"text","disabled":true},{"key":"secondary_remote_id","value":"","description":"(optional) Filter on an ID/number from your system.","type":"text","disabled":true},{"key":"q","value":"","description":"(optional) Partially searches for the given string in the fields:\n- prospect_name_full\n- prospect_name_short\n- tel\n- email\n- remote_id\n","type":"text","disabled":true},{"key":"with","value":"prospectContacts,branch","description":"(optional) Loads the related entities. The following possibilities, comma-seperated:\n- prospectContacts\n- addresses\n- branch"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, private"},{"key":"Date","value":"Tue, 21 Dec 2021 09:16:18 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=500"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"ETag","value":"\"843f4e223747009b33b917be0000b6897512a3be\""},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IjFha0pWd1hMXC9rXC9sM0tcL0NNb3BIMVE9PSIsInZhbHVlIjoiU2JLdkRWbFBFbHRGUWxmME1TNTV1elhcL29pWlhcL1NvNThWQWFhUGlyXC80VUFiMEUreU9WbUF6TVN1Mk5PK2U0RkE2TldGV1VqcTZja2Q4QWVETzdNbzA5blBxRzlkUmgwNktaUVdqZXpJcXdhUmg2VXE4XC84MWo2b1hPbGs1WkMwIiwibWFjIjoiNDg5NDg3MjQzY2NkY2MwM2JmNzJjZWM1OWE0MDM4OTU0OTA4YzkxM2ZkZmM5ZmU3MWJiZjg3YjI1MGFkNGM5ZiJ9; expires=Tue, 21-Dec-2021 11:16:18 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 1,\n \"prospect_name_full\": \"Test Company Inc\",\n \"prospect_name_short\": \"Test Company\",\n \"email\": \"support@winningproposal.nl\",\n \"tel\": \"073-61 33 000\",\n \"type\": 0,\n \"vat\": null,\n \"rpr\": null,\n \"iban\": null,\n \"bic\": null,\n \"contact_person\": null,\n \"contact_person_function\": null,\n \"contact_person_remote_id\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"source\": \"Winning Proposal\",\n \"branch_id\": 1,\n \"sector_id\": null,\n \"remote_id\": null,\n \"search_name\": \"Testbedrijf\",\n \"branch\": {\n \"data\": {\n \"id\": 1,\n \"name\": \"Winning Proposal\",\n \"postal_code\": \"5211 AX\",\n \"street\": \"Oranje Nassaulaan\",\n \"street_number\": \"24\",\n \"city\": \"'s-Hertogenbosch\",\n \"country\": \"Nederland\",\n \"tel\": \"073 61 33 000\",\n \"fax\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"legal\": \"\",\n \"facebook\": null,\n \"linkedin\": null,\n \"twitter\": null,\n \"description\": null,\n \"vat\": null,\n \"rpr\": null,\n \"iban\": null,\n \"bic\": null,\n \"disabled\": 0,\n \"mailing_address\": \"NULL\",\n \"post_office_box\": null,\n \"post_code\": null,\n \"social_media_one\": null,\n \"social_media_two\": null,\n \"remote_id\": null\n }\n },\n \"prospectContacts\": {\n \"data\": [\n {\n \"id\": 1,\n \"prospect_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"full_name\": \"John Doe\",\n \"sex\": \"\",\n \"tel1\": \"\",\n \"tel2\": \"\",\n \"email\": \"john@testco.com\",\n \"remote_id\": null,\n \"secondary_remote_id\": null,\n \"prospect_address_id\": null,\n \"function\": \"Managing director\",\n \"source\": null\n }\n ]\n }\n }\n ]\n}"}],"_postman_id":"0b542486-62b9-4d6f-9e98-25fb66a40aa0"},{"name":"Show","id":"05cc6f20-ee04-4c22-9213-f65f74246a52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/api/public/v1/prospects/{prospect_id}","description":"

Retrieves a single Prospect in Winning Proposal.

(required) The full name of the prospect (e.g. Test Company Inc).

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"prospect_name_short","value":"","description":"

(optional) A shorter version of the name of the prospect (e.g. Test Company).

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"search_name","value":"","description":"

(optional) A specific name a user can search for in the system (e.g. TestCo).

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"user_id","value":"","description":"

(optional) The ID of an user who will become the owner of this prospect.

\n","type":"text","equals":true,"contentType":"integer","disabled":true},{"key":"branch_id","value":"","description":"

(optional) The ID of the branch to which this prospect should be linked.

\n","type":"text","equals":true,"contentType":"integer","disabled":true},{"key":"email","value":"","description":"

(optional) A default contacting email address for this prospect.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"tel","value":"","description":"

(optional) A default contacting phone number for this prospect.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"type","value":"","description":"

(optional) Used to define the type of prospect. Can be one of the following values:\n1: Organisation or\n2: Private

\n","type":"text","equals":true,"contentType":"integer","disabled":true},{"key":"vat","value":"","description":"

(optional) The VAT (BTW) number of this prospect.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"rpr","value":"","description":"

(optional) The RPR (KvK) number of this prospect.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"iban","value":"","description":"

(optional) The IBAN number of this prospect.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"bic","value":"","description":"

(optional) The BIC number of this prospect.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"remote_id","value":"","description":"

(optional) An ID/number from your system. Use this to find this prospect back more easily in other API calls.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"secondary_remote_id","value":"","description":"

(optional) Another ID/number from your system. Use this to find this prospect back more easily in other API calls.

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"contact_person","value":"","description":"

(deprecated)

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"contact_person_function","value":"","description":"

(deprecated)

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"city","value":"","description":"

(deprecated)

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"postal_code","value":"","description":"

(deprecated)

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"address","value":"","description":"

(deprecated)

\n","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"country","value":"","description":"

(deprecated)

\n","type":"text","equals":true,"contentType":"string","disabled":true}]},"url":"/api/public/v1/prospects/","description":"

Creates a new prospect.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{app_user}}"},{"key":"password","value":"{{app_key}}"}]},"isInherited":true,"source":{"_postman_id":"478d41a7-fdf8-48f7-b84a-a2ace8267531","id":"478d41a7-fdf8-48f7-b84a-a2ace8267531","name":"Winning Proposal - P(ublic) API documentation: V1","type":"collection"}},"urlObject":{"path":["api","public","v1","prospects",""],"host":[""],"query":[],"variable":[]}},"response":[{"id":"11bcb3c4-0c21-4b2c-9e39-871d9cfaebe0","name":"Create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"prospect_name_full","value":"Test Company Inc","description":"(required) The full name of the prospect (e.g. Test Company Inc).","type":"text","equals":true,"contentType":"string"},{"key":"prospect_name_short","value":"Test Company","description":"(optional) A shorter version of the name of the prospect (e.g. Test Company).","type":"text","equals":true,"contentType":"string"},{"key":"search_name","value":"TestCo","description":"(optional) A specific name a user can search for in the system (e.g. TestCo).","type":"text","equals":true,"contentType":"string"},{"key":"user_id","value":"1","description":"(optional) The ID of an user who will become the owner of this prospect.","type":"text","equals":true,"contentType":"integer"},{"key":"branch_id","value":"1","description":"(optional) The ID of the branch to which this prospect should be linked.","type":"text","equals":true,"contentType":"integer"},{"key":"email","value":"admin@testco.com","description":"(optional) A default contacting email address for this prospect.","type":"text","equals":true,"contentType":"string"},{"key":"tel","value":"062425472","description":"(optional) A default contacting phone number for this prospect.","type":"text","equals":true,"contentType":"string"},{"key":"vat","value":"","description":"(optional) The VAT (BTW) number of this prospect.","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"rpr","value":"","description":"(optional) The RPR (KvK) number of this prospect.","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"iban","value":"","description":"(optional) The IBAN number of this prospect.","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"bic","value":"","description":"(optional) The BIC number of this prospect.","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"remote_id","value":"ZR111","description":"(optional) An ID/number from your system. Use this to find this prospect back more easily in other API calls.","type":"text","equals":true,"contentType":"string"},{"key":"secondary_remote_id","value":"","description":"(optional) Another ID/number from your system. Use this to find this prospect back more easily in other API calls.","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"contact_person","value":"","description":"(deprecated)","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"contact_person_function","value":"","description":"(deprecated)","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"city","value":"","description":"(deprecated)","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"postal_code","value":"","description":"(deprecated)","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"address","value":"","description":"(deprecated)","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"country","value":"","description":"(deprecated)","type":"text","equals":true,"contentType":"string","disabled":true},{"key":"type","value":"","description":"(optional) Used to define the type of prospect. Can be one of the following values:\n1: Organisation or\n2: Private ","type":"text","equals":true,"contentType":"integer","disabled":true}]},"url":"/api/public/v1/prospects/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store, private"},{"key":"Date","value":"Mon, 20 Dec 2021 14:01:32 GMT"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=500"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"ETag","value":"\"a043f0e43d7aff00ac0cecd02a755db9dc30623d\""},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Ik5sUmFWV2J5dEtqZmNPd1pOWmRmdFE9PSIsInZhbHVlIjoiSk1iOThueFdBVldRa2VvOGxSd0Z0bzA1ZVwvYWJrYzdcL0t4eGF5RUVzanZcL1dcL3RcL2djQVlvNTF1V29UbW9KdDhjUUpPSDQwNkJoUWxid1hOVkJDUk1aVzJNSXBnTlRhRzZqU1AyYVpYdktHd2oweWMzMGdiQmw4Uk01T09MVFN2QiIsIm1hYyI6IjcwODA0M2I0YTVhMDcxMWViMDRhNmNiMzViZjVjYmIyNjQ1ZjU4ZGFiZWIyMmNiNGYyMjkzZjcxNTAwNTVkNWIifQ%3D%3D; expires=Mon, 20-Dec-2021 16:01:32 GMT; Max-Age=7200; path=/; secure; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4,\n \"user_id\": \"1\",\n \"prospect_name_full\": \"Test Company Inc\",\n \"prospect_name_short\": \"Test Company\",\n \"email\": \"admin@testco.com\",\n \"tel\": \"062425472\",\n \"type\": null,\n \"vat\": null,\n \"rpr\": null,\n \"iban\": null,\n \"bic\": null,\n \"contact_person\": null,\n \"contact_person_function\": null,\n \"contact_person_remote_id\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"source\": \"public_api\",\n \"branch_id\": \"1\",\n \"sector_id\": null,\n \"remote_id\": \"ZR111\",\n \"search_name\": \"TestCo\",\n \"files\": {\n \"data\": []\n }\n }\n}"}],"_postman_id":"661a8641-7ce4-4e09-9c8a-e92993a15bb4"},{"name":"Update","id":"152f7603-5969-46d1-991c-03bc57d12454","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"/api/public/v1/prospects/{prospect_id}","description":"

Update an existing prospect.

{prospect_id} represents the ID of the prospect you wish to update.

(optional) The full name of the prospect (e.g. Test Company Inc).