{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3ddb8fd7-4e26-4350-a8de-daf94f72b923","name":"ActiveDEMAND API","description":"## API Integration Process\n\nEach integration that uses our API will need to go through an application and review process. The steps for this process are:  \nRequest a Key  \nYou will need to apply for API access with our partner program in order to get an Application API Key and access our APIs. You can apply here: [https://www2.activedemand.com/api-developer-program](https://www2.activedemand.com/api-developer-program)\n\nView full details of the program here: [https://www2.activedemand.com/api-program-overview](https://www2.activedemand.com/api-program-overview)  \nAfter applying, our integrations team will be in touch with you to get more information about:\n\n- The purpose of your integration\n    \n- The scope of your integration\n    \n\nIf your proposed integration is inline with our acceptable use policies you will receive an API Key as well as access to a test account. In order to make request to our API, you will need to pass this key through in the request header:\n\n`X-Application-Api-Key: APPLICATION_API_KEY`\n\n### Develop the Integration\n\nYou can now build out your integration using the test account you were provided with. If you run into problems or have questions about our API you can contact our integrations team for assistance.\n\n### Submit the Integration for Review\n\nOnce you have completed the development of your integration, you can contact our integrations team to start the review process. Our team will review:\n\n- The security of your integration\n    \n- The functionality of your integration\n    \n- Perform acceptance testing\n    \n\nIf any problems are found that need to be addressed you will be notified and your integration will be moved back to the development step.\n\n### Integration is Published\n\nOnce your integration passes our review process it will be moved into production use. You will now be able to have your users access and use your application in their production accounts.\n\n## ActiveDEMAND API Authentication\n\nActiveDEMAND implements the following endpoints for integrating with external services. All endpoints require an API key.\n\nAPI Base URL:\n\n`https://api.activedemand.com`\n\n### Account Specific API Key\n\nThe ActiveDEMAND account API key can be passed in the X-Api-Key request header field:\n\n`X-Api-Key: APIKEY`\n\nOr as a parameter named api-key:\n\n`https://api.activedemand.com/?api-key=APIKEY`\n\n## ActiveDEMAND API Support\n\nIf you are working on setting up an integration with our API, send an email to [support@activedemand.com](https://mailto:support@activedemand.com) and we will give you access to our #activedemand-api slack channel where you can chat with our developers and have your questions answered.\n\n## How To Submit Custom Fields\n\nCustom fields can be entered in either of two formats.\n\n### Using the custom field ID \\`custom_{id}\\`\n\nThis requires you to know the \\`id\\` for the custom field that you are trying to populate. This can be found by looking up the fields configured on your account.For example if your account is configured with a custom field named \"Department\" with an ID of 1234 on your contact object, you can populate using the following:\n\n``` json\n{\n  \"contact\": {\n    \"custom_1234\": \"Human Resources\"\n  }\n}\n\n ```\n\n### Using the \\`custom_fields\\` array\n\nThis way of entering the custom fields requires that you know the name of the custom field(s) that you want to populate. For example if your account is configured with the custom fields \"Department\" and \"Total YTD Sales\" on your contact object, you can populate using the following:\n\n``` json\n{\n  \"contact\": {\n    \"custom_fields\": [\n      { \"name\": \"Department\", \"value\": \"Human Resources\" },\n      { \"name\": \"Total Sales YTD\", \"value\": 5000.00 }\n    ]\n  }\n}\n\n ```\n\n### Custom Fields Support\n\nThe table below list the objects that currently support the submission of custom fields and the endpoint to lookup the fields available for this object.\n\n| Object | Fields Endpoint |\n| --- | --- |\n| Contact | [/v1/contacts/fields](https://jumpdemand.postman.co/workspace/JumpDEMAND-API~be994ae1-1bc2-4942-86e1-465ccc72d21a/request/6051223-8e87baef-11ad-497e-96af-ea021037d94b?ctx=documentation) |\n| Organization | \\- |\n| Deal | [/v1/deals/fields](https://jumpdemand.postman.co/workspace/JumpDEMAND-API~be994ae1-1bc2-4942-86e1-465ccc72d21a/request/6051223-fc7b7ff9-885f-46a4-807d-b85f444214cd?ctx=documentation) |\n| Task | \\- |\n| Form | [/v1/forms/fields?form_id=12345](https://jumpdemand.postman.co/workspace/JumpDEMAND-API~be994ae1-1bc2-4942-86e1-465ccc72d21a/request/6051223-cce42b3b-463b-4491-bbeb-aa487f6a6e57?ctx=documentation) |\n| History | [v1/histories/fields](https://jumpdemand.postman.co/workspace/JumpDEMAND-API~be994ae1-1bc2-4942-86e1-465ccc72d21a/request/6051223-f828477d-519e-4a09-8872-05a65eda4296?ctx=documentation) |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13809894","team":601434,"collectionId":"3ddb8fd7-4e26-4350-a8de-daf94f72b923","publishedId":"2sB3dHUsc7","public":true,"publicUrl":"https://developers.activedemand.com","privateUrl":"https://go.postman.co/documentation/13809894-3ddb8fd7-4e26-4350-a8de-daf94f72b923","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","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.11.6","publishDate":"2025-11-21T18:15:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"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/7ceca5be2f54b8d408d53846535575b8371d6d4747a592ffe12d3ef4337dea34","favicon":"https://activedemand.com/favicon.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://developers.activedemand.com/view/metadata/2sB3dHUsc7"}