{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"478d41a7-fdf8-48f7-b84a-a2ace8267531","name":"Winning Proposal - P(ublic) API documentation: V1","description":"Compatible with Winning Proposal system versions:\n\n- 9.\\*.\\*\n    \n- 8.\\*.\\*\n    \n- 7.\\*.\\*\n    \n- 6.\\*.\\*\n    \n- 5.\\*.\\*\n    \n- 4.\\*.\\*\n    \n- 3.\\*.\\*\n    \n\n# Introduction\n\nThe 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.\n\nThis documentation provides an overview of all available endpoints, the required requests, and the expected responses.\n\n# Authentication & Security\n\nAlthough the API is publicly accessible, all requests must be properly authenticated. Winning Proposal uses the **Basic Authentication** scheme to verify each request.\n\n#### Constructing the Authorization Header\n\nTo access the API, every request must include an `Authorization` header containing a value based on your application's name and the provided `client_secret`.\n\nFollow these steps to construct the header:\n\n1. Concatenate your application name and `client_secret` using a semicolon (`;`):  \n    `application_name;client_secret`\n    \n2. Encode the resulting string in **Base64**.\n    \n3. Prefix the encoded string with `'Basic '` (note the space).\n    \n4. Add this full string as the value of the `Authorization` header in your request.\n    \n\nExample:  \n`Authorization: Basic YXBwbmF0aW9uX25hbWU7Y2xpZW50X3NlY3JldA==`\n\n<img src=\"https://winning-proposal.imgix.net/wp-ami/6AMEdJTkdP7knflkKtZTGKadMxDwUNflfpCUpdjeis6LK2qlmWuqEKVCxWDD/api-docs-php.png\" alt=\"PHP%20example\">\n\n<img src=\"https://content.pstmn.io/c0d0eb0b-c4d1-4ecb-9b3d-de35924d842e/aW1hZ2UucG5n\" alt=\"Postman%20example\" width=\"952\" height=\"249\">\n\n#### Access Requirements\n\nTo successfully perform an API call, the following requirements must be met:\n\n- The application must be **registered** within Winning Proposal (you will receive the name and `client_secret`).\n    \n- The application must be marked as **active**.\n    \n- API calls must originate from a **whitelisted IP address**.\n    \n- Each endpoint is protected by specific **permissions**.\n    \n\nIf 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.\n\n# Remote id's\n\nSome 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.\n\nStartFragment\n\n### Including Relationships in GET Requests\n\nMany GET endpoints allow you to **eager-load** related entities using the `with` query parameter.\n\n- Use a **comma (****`,`****)** to include multiple relationships.\n    \n- Use a **dot (****`.`****)** to traverse nested relationships.\n    \n\nFor example:\n\n**GET /public/api/v1/prospects?with=prospectContacts**\n\nThis will retrieve the entity along with its related client, the client's contact person.\n\nThe available relationships for each endpoint are listed in the parameter reference. Refer to the image below for an example of an eager-loaded response.\n\n<img src=\"https://winning-proposal.imgix.net/wp-ami/YsTusAcL7Chk0RJSNSixihZoXDVx2ioJKusH8sUGbFACsXkC18Ci1HXKCPU1/api-docs-json.png\">","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4270458","team":2905988,"collectionId":"478d41a7-fdf8-48f7-b84a-a2ace8267531","publishedId":"2sB2xBCpH2","public":true,"publicUrl":"https://papi-documentation-v1.winningproposal.nl","privateUrl":"https://go.postman.co/documentation/4270458-478d41a7-fdf8-48f7-b84a-a2ace8267531","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Public API documentation: V1"},{"name":"title","value":"Public API documentation: V1"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-06-20T12:22:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Public API documentation: V1","description":"Public API documentation: V1"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/a52446ec1a5035f134e2e3cce40b5d644590028d184ca2e24d89a063180af997","favicon":"https://res.cloudinary.com/postman/image/upload/v1639744546/team/lfcwiulcbohf91rbgrkj.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://papi-documentation-v1.winningproposal.nl/view/metadata/2sB2xBCpH2"}