Follow this documentation to seamlessly integrate the Tickd Pulse API into your system.
\nYou will receive a separate document containing the values to use in place of the variables throughout this documentation.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"24462368","collectionId":"cbdb75db-8f3e-485e-9bd5-8e9b677c4436","publishedId":"2sA3JRaeyD","public":true,"customColor":{"top-bar":"f4f5f7","right-sidebar":"2D425B","highlight":"008ffd"},"publishDate":"2024-05-22T13:24:29.000Z"},"item":[{"name":"Auth","item":[{"name":"SignIn","id":"a85eba84-0d43-424e-9740-381e7013454b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"string\",\r\n \"password\": \"string\",\r\n \"newPassword\": \"string | null\" // only required when changing password\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/sign-in","urlObject":{"path":["auth","sign-in"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7b73c8e1-d9bf-49c6-a815-28738fb623c1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"example\",\r\n \"password\": \"YourPassword123!\",\r\n \"newPassword\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/sign-in"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1175"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 28 Feb 2025 12:18:03 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67c1a97a-5f644f7925b410824d861909"},{"key":"x-amzn-RequestId","value":"d110346e-013e-467f-b7ff-9f48a4472254"},{"key":"x-amz-apigw-id","value":"GsdrMFYwLPEEUFg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c4ff0051ca0c026ecfda9d67a3f79e8a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C3"},{"key":"X-Amz-Cf-Id","value":"vnb1VlsEIajBTTmNd8WZUHvCzw_l2euXmx-ROpzsujhFNACCjBKlVA=="}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJraWQiOiIxbXJvOFFCXC9WV1VUMTBXWk1qbWVnWHB2NGpuYW05RlNZSWxEa3dBalwvak09IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJiNmQyMzI5NC05MGYxLTcwNzgtZjI0NC1mNmI5NmMzMWVlZjgiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmV1LXdlc3QtMi5hbWF6b25hd3MuY29tXC9ldS13ZXN0LTJfV0N1WlhWMEZHIiwiY29nbml0bzp1c2VybmFtZSI6ImFsZXgucm93ZSIsIm9yaWdpbl9qdGkiOiI0MjkwMzRmZi1lZmUwLTQ1MTItOWNhYi1kYWI5Y2Y0NDYyNzgiLCJhdWQiOiI0ODdsNm1xbzc1aDFoaGxsb3FuZnEzbnFwZyIsImV2ZW50X2lkIjoiODkwY2Y3MWItYWYzOC00YmRiLTk4NGEtM2ZiMGRhMDQ4MjdmIiwidG9rZW5fdXNlIjoiaWQiLCJhdXRoX3RpbWUiOjE3NDA3NDUwODMsImV4cCI6MTc0MDc0ODY4MywiaWF0IjoxNzQwNzQ1MDgzLCJqdGkiOiI0MTliYzg0Yy04ZmZmLTQyZjYtODA2Yy1lY2Y4ZWE0OTRhZTkiLCJlbWFpbCI6ImFsZXgucm93ZUB0aWNrZC5jby51ayJ9.Jh6SkqLBrkXcZmL8eec35AykOrydW-dZDiS-8S0vKw0PmR-_KmVnyv2zJBHJvcmH6HLISKTG_dW8rEEyh-RiWR5lwTdZj722xpi71muhekIoLvN8KgJrr98h0TE382s7YMvKJVZc_DHxzNDj9vCwafoOwU8JzRR5J1T2OtZ1toS56ivMvsuu2KJpDR8JXslvf44cj1ubP7kEyTaZmBAQ-aBIrgNk5o6eNRkNivbmJMIXLAS3idOkEqpkDJ2WSySD5xGx0cXrYv637HzpaCrd19JhSN89T2b6F_eH040CMwrTrN3MwTlV-K9Ax1J4UQgsA_36jmR1hNdue0rr0SvWRw\",\n \"error\": null,\n \"success\": true,\n \"status\": 200,\n \"messages\": [],\n \"errors\": [],\n \"timestamp\": \"2025-02-28T12:18:03.2073793Z\"\n}"},{"id":"52a6134c-e1b6-4918-b90a-03b1885d88a8","name":"IncorrectDetails","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"incorrectusername\",\r\n \"password\": \"incorrectpassword\",\r\n \"newPassword\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/sign-in"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 28 Feb 2025 12:14:00 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67c1a885-1fc2cdf072481ced6ca98f9b"},{"key":"x-amzn-RequestId","value":"9aef6414-6aa1-41fc-b173-6e41a581ec33"},{"key":"x-amz-apigw-id","value":"GsdE8Ex-LPEEibQ="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c4ff0051ca0c026ecfda9d67a3f79e8a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C3"},{"key":"X-Amz-Cf-Id","value":"ZsRDww0o6x9d22kPBgfG9YbMPntbgwgt2aFSS0e0-1q2Tje7bBcN3g=="}],"cookie":[],"responseTime":null,"body":"{\n \"token\": null,\n \"error\": \"Incorrect username or password.\",\n \"success\": false,\n \"status\": 401,\n \"messages\": [],\n \"errors\": [],\n \"timestamp\": \"2025-02-28T12:14:00.3242102Z\"\n}"},{"id":"6d78aef0-e16e-40d1-9499-ddb4c82614f3","name":"NewPasswordRequired","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"example\",\r\n \"password\": \"Password123!\",\r\n \"newPassword\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/sign-in"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"146"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 28 Feb 2025 12:16:15 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67c1a90f-77c48b620991e41539ab1479"},{"key":"x-amzn-RequestId","value":"18726af4-841f-420d-ab4e-9c665cad7866"},{"key":"x-amz-apigw-id","value":"GsdacEB1LPEEOqA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c4ff0051ca0c026ecfda9d67a3f79e8a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C3"},{"key":"X-Amz-Cf-Id","value":"7GzH4V0k7WIhsjJabRXpVrP5an3LxzXO9LuCsZIy3Yo_DqsR0vI2HA=="}],"cookie":[],"responseTime":null,"body":"{\n \"token\": null,\n \"error\": \"New password is required.\",\n \"success\": false,\n \"status\": 403,\n \"messages\": [],\n \"errors\": [],\n \"timestamp\": \"2025-02-28T12:37:37.1754762Z\"\n}"},{"id":"71a3bf4a-e55e-4ad1-a8fb-6452872680bf","name":"NewPasswordErrors","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"example\",\r\n \"password\": \"Password123!\",\r\n \"newPassword\": \"password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/sign-in"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"182"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 28 Feb 2025 12:16:55 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-67c1a937-572947413a0f51083ba211fe"},{"key":"x-amzn-RequestId","value":"e3f7d625-afa2-4dc6-8b7d-23a0c481c014"},{"key":"x-amz-apigw-id","value":"GsdguF8UrPEEA7w="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c4ff0051ca0c026ecfda9d67a3f79e8a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C3"},{"key":"X-Amz-Cf-Id","value":"KMFTWV5h4ka0QsOrP6V291KSmAzssOznjGAieeW_gPOCmYWqVMBLzQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"token\": null,\n \"error\": \"Password does not conform to policy: Password not long enough\",\n \"success\": false,\n \"status\": 400,\n \"messages\": [],\n \"errors\": [],\n \"timestamp\": \"2025-02-28T12:39:20.5205093Z\"\n}"}],"_postman_id":"a85eba84-0d43-424e-9740-381e7013454b"},{"name":"ForgotPassword","id":"efcc0e67-9577-478c-ad10-c70b34cc65db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"string\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/forgot-password","urlObject":{"path":["auth","forgot-password"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"efcc0e67-9577-478c-ad10-c70b34cc65db"},{"name":"ResetPassword","id":"ad29bbd0-ac38-4b61-8f2b-a648420f95d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"string\",\r\n \"confirmationCode\": \"string\", // sent via email triggered by /forgot-password\r\n \"password\": \"string\" // set new password \r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/reset-password","urlObject":{"path":["auth","reset-password"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad29bbd0-ac38-4b61-8f2b-a648420f95d8"},{"name":"ChangePassword","id":"9464f9c6-6227-4c2e-bd73-aab4fcc00744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"string\",\r\n \"oldPassword\": \"string\",\r\n \"newPassword\": \"string\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/auth/change-password","urlObject":{"path":["auth","change-password"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9464f9c6-6227-4c2e-bd73-aab4fcc00744"}],"id":"2ef42ee7-bbff-4357-93b9-4c64547f5bdd","description":"Use your username and password to authenticate to the platform.
\nTickd will create an account for you to authenticate with. You will receive your username and initial password via an email.
\nUpon your first request you will be required to provide a \"newPassword\", which can then be used for all requests in the future.
\nYour new password must:
\nBe a minimum of 8 characters long.
\nInclude a capital letter.
\nInclude a numeric character.
\nInclude a special character.
\nYou will receive a JWT token which can then be utilised when making requests to all other pulse endpoints.
\n","_postman_id":"2ef42ee7-bbff-4357-93b9-4c64547f5bdd"},{"name":"Address Lookup","item":[{"name":"Postcode","id":"fa4f5861-2f4f-4480-9f53-55f3299a736f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/addressutility/address-lookup/postcode?postcode={postcode}&fuelType=1&brokerId={id}","urlObject":{"path":["addressutility","address-lookup","postcode"],"host":["{{PULSE_BASE_URL}}"],"query":[{"key":"postcode","value":"{postcode}"},{"key":"fuelType","value":"1"},{"key":"brokerId","value":"{id}"}],"variable":[]}},"response":[{"id":"44e1f39f-005f-4e0c-b897-c4bc1ac5bf7f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PULSE_BASE_URL}}/addressutility/address-lookup/postcode?postcode={postcode}&fuelType=1&brokerId={id}","host":["{{PULSE_BASE_URL}}"],"path":["addressutility","address-lookup","postcode"],"query":[{"key":"postcode","value":"{postcode}"},{"key":"fuelType","value":"1"},{"key":"brokerId","value":"{id}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status\": 200,\n \"messages\": [\n \"string\"\n ],\n \"errors\": [\n \"string\"\n ],\n \"timestamp\": \"string\",\n \"addresses\": [\n {\n \"udprn\": \"string\",\n \"mpxn\": \"string\",\n \"addressId\": \"string\",\n \"meterType\": 0,\n \"additionalInformation\": \"string\",\n \"poBox\": \"string\",\n \"subBuilding\": \"string\",\n \"buildingName\": \"string\",\n \"buildingNumber\": \"string\",\n \"subStreet\": \"string\",\n \"street\": \"string\",\n \"subLocality\": \"string\",\n \"locality\": \"string\",\n \"town\": \"string\",\n \"county\": \"string\",\n \"postCode\": \"string\",\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"uniqueIdentifierHash\": 0\n }\n ]\n}"},{"id":"6823813c-b3b4-4d0c-9b1e-06cf5aed15c8","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":{"raw":"{{PULSE_BASE_URL}}/addressutility/address-lookup/postcode?postcode={postcode}&fuelType=1&brokerId={id}","host":["{{PULSE_BASE_URL}}"],"path":["addressutility","address-lookup","postcode"],"query":[{"key":"postcode","value":"{postcode}"},{"key":"fuelType","value":"1"},{"key":"brokerId","value":"{id}"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 19 May 2024 13:43:41 GMT"},{"key":"x-amzn-RequestId","value":"b2654c6f-9631-4530-b2be-938c9c34a4df"},{"key":"x-amz-apigw-id","value":"YBVCDH9qLPEEL6g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-664a020c-08cf66d6355fcc8324fb6b83;Parent=4ad9a0d6582c50fc;Sampled=0;lineage=bd6e312a:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b730df6995cd214c47b65c5bd9c5eb3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAN50-C2"},{"key":"X-Amz-Cf-Id","value":"6ZM8BFBBRNHDeCtAWGU6WXA_N2gfS9BEtNcL50WZtMIH8HToy72iNg=="}],"cookie":[],"responseTime":null,"body":"{\n \"addresses\": null,\n \"success\": false,\n \"status\": 500,\n \"messages\": [],\n \"errors\": [\n \"An unhandled error has occurred.\"\n ]\n}"}],"_postman_id":"fa4f5861-2f4f-4480-9f53-55f3299a736f"},{"name":"Mpan","id":"d187d674-7d7d-429c-971d-2784aa8246c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/addressutility/address-lookup/mpan?mpan={mpan}&brokerId={id}","urlObject":{"path":["addressutility","address-lookup","mpan"],"host":["{{PULSE_BASE_URL}}"],"query":[{"key":"mpan","value":"{mpan}"},{"key":"brokerId","value":"{id}"}],"variable":[]}},"response":[{"id":"ef6d4511-8585-40bf-a7e1-17abdc50d72a","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":{"raw":"{{PULSE_BASE_URL}}/addressutility/address-lookup/mpan?mpan={mpan}&brokerId={id}","host":["{{PULSE_BASE_URL}}"],"path":["addressutility","address-lookup","mpan"],"query":[{"key":"mpan","value":"{mpan}"},{"key":"brokerId","value":"{id}"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 19 May 2024 13:43:41 GMT"},{"key":"x-amzn-RequestId","value":"b2654c6f-9631-4530-b2be-938c9c34a4df"},{"key":"x-amz-apigw-id","value":"YBVCDH9qLPEEL6g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-664a020c-08cf66d6355fcc8324fb6b83;Parent=4ad9a0d6582c50fc;Sampled=0;lineage=bd6e312a:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b730df6995cd214c47b65c5bd9c5eb3e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAN50-C2"},{"key":"X-Amz-Cf-Id","value":"6ZM8BFBBRNHDeCtAWGU6WXA_N2gfS9BEtNcL50WZtMIH8HToy72iNg=="}],"cookie":[],"responseTime":null,"body":"{\n \"addresses\": null,\n \"success\": false,\n \"status\": 500,\n \"messages\": [],\n \"errors\": [\n \"An unhandled error has occurred.\"\n ]\n}"},{"id":"b3c95fdc-ad38-4a18-99ae-8bb4588f68f8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PULSE_BASE_URL}}/addressutility/address-lookup/mpan?mpan={mpan}&brokerId={id}","host":["{{PULSE_BASE_URL}}"],"path":["addressutility","address-lookup","mpan"],"query":[{"key":"mpan","value":"{mpan}"},{"key":"brokerId","value":"{id}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status\": 200,\n \"messages\": [\n \"string\"\n ],\n \"errors\": [\n \"string\"\n ],\n \"timestamp\": \"string\",\n \"addresses\": [\n {\n \"udprn\": \"string\",\n \"mpxn\": \"string\",\n \"addressId\": \"string\",\n \"meterType\": 0,\n \"additionalInformation\": \"string\",\n \"poBox\": \"string\",\n \"subBuilding\": \"string\",\n \"buildingName\": \"string\",\n \"buildingNumber\": \"string\",\n \"subStreet\": \"string\",\n \"street\": \"string\",\n \"subLocality\": \"string\",\n \"locality\": \"string\",\n \"town\": \"string\",\n \"county\": \"string\",\n \"postCode\": \"string\",\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"uniqueIdentifierHash\": 0\n }\n ]\n}"}],"_postman_id":"d187d674-7d7d-429c-971d-2784aa8246c1"},{"name":"DetailedMpan","id":"7cb92a74-a044-4f00-bff8-57c9dc11185a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This endpoint retrieves detailed meter information for a property based on the provided mpxn and fuelType. If fuelType is 0 (electricity), the response includes electricity meter details and the corresponding gas meter if available (some properties might not have a gas meter). If fuelType is 1 (gas), the response includes gas meter details and the corresponding electricity meter.
\n","urlObject":{"path":["addressutility","address-lookup","detailed-electricity-gas"],"host":["{{PULSE_BASE_URL}}"],"query":[{"key":"mpxn","value":"{mpxn}"},{"key":"brokerId","value":"{brokerId}"},{"description":{"content":"0 - electricity, 1 - gas
\n","type":"text/plain"},"key":"fuelType","value":"{fuelType}"}],"variable":[]}},"response":[{"id":"61d9108e-e972-4628-b2e7-882368907a71","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{token}","type":"text"}],"url":{"raw":"{{PULSE_BASE_URL}}/addressutility/address-lookup/detailed-electricity-gas?mpxn={mpxn}&brokerId={brokerId}&fuelType={fuelType}","host":["{{PULSE_BASE_URL}}"],"path":["addressutility","address-lookup","detailed-electricity-gas"],"query":[{"key":"mpxn","value":"{mpxn}"},{"key":"brokerId","value":"{brokerId}"},{"key":"fuelType","value":"{fuelType}","description":"0 - electricity, 1 - gas"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"status\": 200,\r\n \"messages\": [\r\n \"string\"\r\n ],\r\n \"errors\": [\r\n \"string\"\r\n ],\r\n \"timestamp\": \"string\",\r\n \"result\": {\r\n \"electricityDetails\": [\r\n {\r\n \"utilityKey\": \"string\",\r\n \"utilityType\": \"string\",\r\n \"utilityDetails\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"meters\": [\r\n {\r\n \"meterDetails\": [\r\n {\r\n \"key\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"gasDetails\": [\r\n {\r\n \"addressId\": \"string\",\r\n \"currentSupplierId\": \"string\",\r\n \"currentSupplierName\": \"string\",\r\n \"meterCapacity\": \"string\",\r\n \"meterSerialNumber\": \"string\",\r\n \"mprn\": \"string\",\r\n \"mpaq\": \"string\",\r\n \"ldzId\": \"string\",\r\n \"uprn\": \"string\",\r\n \"address\": [\r\n {\r\n \"primaryName\": \"string\",\r\n \"secondaryName\": \"string\",\r\n \"street1\": \"string\",\r\n \"street2\": \"string\",\r\n \"locality1\": \"string\",\r\n \"locality2\": \"string\",\r\n \"town\": \"string\",\r\n \"postcode\": \"string\",\r\n \"logicalStatus\": \"string\",\r\n \"language\": \"string\",\r\n \"organisation\": \"string\",\r\n \"addressType\": \"string\",\r\n \"confidenceScore\": \"string\",\r\n \"classification\": \"string\",\r\n \"latitude\": \"string\",\r\n \"longitude\": \"string\"\r\n }\r\n ],\r\n \"gasTransportId\": \"string\",\r\n \"meterPointStatus\": \"string\",\r\n \"houseName\": \"string\",\r\n \"subBuildingName\": \"string\",\r\n \"houseNumber\": \"string\",\r\n \"county\": \"string\",\r\n \"postTown\": \"string\",\r\n \"postcode\": \"string\",\r\n \"street\": \"string\",\r\n \"amrIndicator\": \"string\",\r\n \"currentSupplierRegEffectiveDate\": \"string\",\r\n \"pendingSupplierRegEffectiveDate\": \"string\",\r\n \"meterInstallationDate\": \"string\",\r\n \"exitZone\": \"string\",\r\n \"meterImperialIndicator\": \"string\",\r\n \"meterModel\": \"string\",\r\n \"incomingSupplier\": \"string\",\r\n \"lastMeterReadDate\": \"string\",\r\n \"lastMeterReadValue\": \"string\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"33379365-842f-4a86-a943-4934e1b5f3eb"}],"id":"ff60ea21-7175-43a5-9b00-a740d5cec9eb","description":"Leverage these endpoints to fetch up to date address and meter data from the industry, that match your search criteria.
\nDisclaimer
\nWhen retrieving address details using the below endpoints, you will receive an 'mpxn' value as part of the response. If you do an electricity search, this will be your mpan value, whereas if you do a gas address search this will be your mprn value.
\nPostcode search
\nWhen using the postcode lookup endpoint, you can provide a 'utilityType' value to specificy an electricity or gas search, where 0 = Electricity and 1 = Gas. Should you not include this in the request, the search will default to an electricity lookup.
\nPlease note that gas address searches via postcode won't return an MPRN value, but an address ID instead.
\nMpan search
\nShould you know the mpan of the meter already, you can utilise the value here to retrieve the rest of the relating address data.
\nMprn search
\nShould you know the mprn of the meter already, you can utilise the value here to retrieve the rest of the relating address data.
\n","_postman_id":"ff60ea21-7175-43a5-9b00-a740d5cec9eb"},{"name":"Charity Lookup","item":[{"name":"Name","id":"f8ede5c0-39b8-4eb1-a288-56834789882f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":"{{PULSE_BASE_URL}}/charity/name?name={charityName}","urlObject":{"path":["charity","name"],"host":["{{PULSE_BASE_URL}}"],"query":[{"key":"name","value":"{charityName}"}],"variable":[]}},"response":[{"id":"789d6fac-ea00-4cc0-8058-74203a1fe1f9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":"{{PULSE_BASE_URL}}/charity/name/{charityName}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"573"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 19 May 2024 13:53:40 GMT"},{"key":"x-amzn-RequestId","value":"558cb2f4-4ce4-4b78-b406-0eb72cd63a0c"},{"key":"x-amz-apigw-id","value":"YBWfLFLbrPEEXsQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-664a0460-5ed95c8d7bc07257088ecc2b;Parent=7fa9611bd47a1c8f;Sampled=0;lineage=58c306c6:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 bf7ddccbb38083d1ce515f8046ed53b4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAN50-C2"},{"key":"X-Amz-Cf-Id","value":"0ZsP-Ga5G-c9ElLvzegkY6DB7kXUWwBcoXAkW1BfpPO4jwLf2yuN1w=="}],"cookie":[],"responseTime":null,"body":"{\n \"charities\": [\n {\n \"name\": \"Leverage these endpoints to fetch up to date charity data, that match your search criteria.
\nName search
\nBy utilising the charity search via name, you will receive fundamental data relating to the charities, including their registration number.
\nNumber search
\nBy utilising the charity search via registration number, you will receive a slightly more in depth view of the data relating to this charity.
\n","_postman_id":"a3e8d45b-b627-4e4a-bc91-2e1f61901f53"},{"name":"Company Lookup","item":[{"name":"Limited","item":[{"name":"Registration number","id":"9b0122b8-eab5-4ae3-9c85-e41790b4a3cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":"{{PULSE_BASE_URL}}/company/number?companynumber={companyNumber}","urlObject":{"path":["company","number"],"host":["{{PULSE_BASE_URL}}"],"query":[{"key":"companynumber","value":"{companyNumber}"}],"variable":[]}},"response":[{"id":"fd329321-3693-45fe-be18-37259b3b451d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":"{{PULSE_BASE_URL}}/company/number/{companyNumber}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"780"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 19 May 2024 14:25:07 GMT"},{"key":"x-amzn-RequestId","value":"2b644907-4d03-4481-b920-aa61d7638f13"},{"key":"x-amz-apigw-id","value":"YBbGSHZhrPEEWhQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-664a0bc1-186f5cad2cab80811ea5d681;Parent=366b16267ebddb2d;Sampled=0;lineage=19789342:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1a97a9eebcc711c0fc19ac157ae64d20.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAN50-C2"},{"key":"X-Amz-Cf-Id","value":"Smt7O88sDzIegqRH58hPIeSZAnaSxKzvWMuIKsZg_FMJgHpoEdu3hA=="}],"cookie":[],"responseTime":null,"body":"{\n \"company\": {\n \"name\": \"Leverage these endpoints to fetch up to date LTD company data, that match your search criteria.
\nName search
\nBy utilising the company search via name, you will receive fundamental data relating to the companies, including their registration number.
\nNumber search
\nBy utilising the company search via registration number, you will receive a slightly more in depth view of the data relating to this company.
\n","_postman_id":"1290e88b-1ac8-4f6f-84db-2ff83c07f2ec"},{"name":"Sole Trader","item":[{"name":"Sole trader","id":"34541034-a83f-4d5e-85b3-d11b00cbce33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":"{{PULSE_BASE_URL}}/company/sole-trader?name={companyName}&postcode={postCode}","urlObject":{"path":["company","sole-trader"],"host":["{{PULSE_BASE_URL}}"],"query":[{"key":"name","value":"{companyName}"},{"key":"postcode","value":"{postCode}"}],"variable":[]}},"response":[{"id":"8d96441f-b73c-4414-8a78-293acca33d51","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"url":{"raw":"{{PULSE_BASE_URL}}/company/sole-trader?name={soleTraderName}&postcode={soleTraderPostcode}","host":["{{PULSE_BASE_URL}}"],"path":["company","sole-trader"],"query":[{"key":"name","value":"{soleTraderName}"},{"key":"postcode","value":"{soleTraderPostcode}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1179"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 19 May 2024 14:28:14 GMT"},{"key":"x-amzn-RequestId","value":"55dad3c9-3a6a-4f30-8d8d-22889ec07c26"},{"key":"x-amz-apigw-id","value":"YBbjlEKVrPEEiww="},{"key":"X-Amzn-Trace-Id","value":"Root=1-664a0c7d-3eb6f8104c5f05097ff98ab1;Parent=29597288a0a43f35;Sampled=0;lineage=19789342:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1a97a9eebcc711c0fc19ac157ae64d20.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAN50-C2"},{"key":"X-Amz-Cf-Id","value":"GquZUTlfIK8OrDjQoFp_VV0IBXSl44VivLzgYlFD7EO142kWVsb-jA=="}],"cookie":[],"responseTime":null,"body":"{\n \"companies\": [\n {\n \"name\": \"By utilising the sole trader search, you will receive the fundamental details relating to the business including the registration number where possible.
\n","_postman_id":"c8cb23d5-3a99-4ec3-97eb-1b0a595eacf1"}],"id":"ef4c6a90-5d10-4681-8ff1-230af9a15e3f","description":"Leverage these endpoints to fetch up to date company data, that match your search criteria.
\n","_postman_id":"ef4c6a90-5d10-4681-8ff1-230af9a15e3f"},{"name":"Quote","item":[{"name":"Electricity","id":"e781704a-562a-4817-88da-d3235c7e3978","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"aut","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"companyNumber\": \"{companyRegistrationNumber}\",\r\n \"companyName\": \"{companyName}\",\r\n \"creditScore\": 50, //int - nullable\r\n \"companyPostcode\": \"{companyPostcode}\", // ST only\r\n \"estimatedAnnualConsumption\": 10000,\r\n \"startDate\": \"2024-05-17\",\r\n \"expirationDate\": \"2025-04-17\", // nullable\r\n \"mpxn\": \"01234567\",\r\n \"brokerId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"companyType\": 0, // ENUM: 0 = LIMITED, 1 = CHARITY, 2 = SOLETRADER | Defaults to 0\r\n \"affiliate\": \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/quote/quick/electricity","urlObject":{"path":["quote","quick","electricity"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"63c0cf22-d330-42eb-b08e-bca2e731005c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"companyNumber\": \"{companyRegistrationNumber}\",\r\n \"estimatedAnnualConsumption\": 10000,\r\n \"startDate\": \"2024-05-17\",\r\n \"mpxn\": \"0123456789012\",\r\n \"postcode\": \"{postcode}\",\r\n \"brokerId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"affiliate\": \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/quote/electricity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 19 May 2024 14:15:57 GMT"},{"key":"x-amzn-RequestId","value":"a4862c5a-1793-4527-9124-a9b81bf050e8"},{"key":"x-amzn-ErrorType","value":"MissingAuthenticationTokenException"},{"key":"x-amz-apigw-id","value":"YBZwlH7gLPEEs2w="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 14cafb18d63089cda854188e9438d37c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MAN50-C2"},{"key":"X-Amz-Cf-Id","value":"UJhD2FAgY3VwNjEOleUh5c_RgGTXodjmqtQySdXBLZtlw8cJYmkxjw=="}],"cookie":[],"responseTime":null,"body":"{\n \"quotes\": [\n {\n \"quote\": {\n \"id\": \"Leverage these endpoints to real time electricity and/or gas SME energy quotes passed on the details that you provide in the request. Please note that these quotes change daily.
\nBuilding the electricity request
\ncompanyNumber - use the 'number' value in the charity/company response
\ncompanyName - primarily used for generating sole trader quotes
\ncreditScore - if you have the credit score for the company, this can be added here. If no credit score is provided, a credit check will be carried out by the quoting service
\ncompanyPostcode - only used for generating sole trader quotes
\ncompanyType - 0 = LTD, 1 = Charity, 2 = Sole Trader | defaults to 0 if not populated
\nestimatedAnnualConsumption - User input
\nstartDate - user input
\nmpxn - use the 'mpxn' value in the electricity postcode or mpan lookup response, or alternatively from user input
\npostcode - found in the address lookyp responses or user input
\nbrokerId - supplied in supporting documentation
\nBuilding the gas request
\nFor the following data required in these requests, you can retrieve them by utilising the other endpoints available via the Tickd Pulse API:
\ncompanyNumber - use the 'number' value in the charity/company response.
\ncompanyName - primarily used for generating sole trader quotes
\ncompanyPostcode - only used for generating sole trader quotes
\ncompanyType - 0 = LTD, 1 = Charity, 2 = Sole Trader | defaults to 0 if not populated
\nestimatedAnnualConsumption - User input
\nstartDate - user input
\nmpxn - use the 'mpxn' value in the gas postcode or mpan lookup response, or alternatively from user input
\naddressId - found in the gas postcode address lookup response
\npostcode - found in the address lookup responses or user input
\nbrokerId - supplied in supporting documentation
\nAvailable Suppliers
\n","_postman_id":"80995663-ae66-49ef-8b5e-335ab98e963a"},{"name":"Validation","item":[{"name":"Bank details","id":"3586c0c9-ef51-4090-b411-09690ca28e1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"aut","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"55779911\",\r\n \"sortCode\": \"200000\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/validation/bank-details","urlObject":{"path":["validation","bank-details"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ed340bd0-8f68-45c3-af30-4cfa6789f7bf","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}"},{"key":"Authorization","value":"{token}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\": \"Leverage this endpoint to validate bank details.
\nPlease note that requests made to the UAT API will always return true.
\nShould the 'type' value within the response return as '1' via production requests, please note that this particular request wasn't able to be validated correctly due to a potential outage.
\n","_postman_id":"8b7f0249-5ac5-4072-b55b-9b401ab6448d"},{"name":"Journeys","item":[{"name":"Completed Journeys","id":"010bcdaf-ea23-4612-86d7-cda425789156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"endDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"nextToken\": \"string | null\",\r\n \"clientId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/journeys/v2/range/complete","urlObject":{"path":["journeys","v2","range","complete"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"00f14b42-6803-4eb1-b479-ca12d012ebef","name":"Completed Journeys","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"endDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"nextToken\": \"string | null\",\r\n \"clientId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/journeys/v2/range/complete"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"result\": [\r\n\t\t{\r\n\t\t\t\"fuelType\": \"string | null\",\r\n\t\t\t\"contractSignedDate\": \"string | null\",\r\n\t\t\t\"mpxn\": \"string | null\",\r\n\t\t\t\"contractStartDate\": \"string | null\",\r\n\t\t\t\"contractEndDate\": \"string | null\",\r\n\t\t\t\"affiliate\": \"string | null\",,\r\n\t\t\t\"creationType\": \"string | null\",\r\n\t\t\t\"creationTime\": \"string | null\",\r\n\t\t\t\"renewalQuoteUrl\": \"string | null\",,\r\n\t\t\t\"reapplicationDate\": \"string | null\",,\r\n\t\t\t\"supplyData\": {\r\n\t\t\t\t\"supplyType\": 0,\r\n\t\t\t\t\"startDate\": \"string | null\",\r\n\t\t\t\t\"usageDetails\": {\r\n\t\t\t\t\t\"mpxn\": \"string | null\",\r\n\t\t\t\t\t\"spend\": \"string | null\",\r\n\t\t\t\t\t\"energy\": \"string | null\",\r\n\t\t\t\t\t\"period\": 1, //Enum - 0 = Monthly, ` = Yearly\r\n\t\t\t\t\t\"eac\": \"string | null\",\r\n\t\t\t\t\t\"currentSupplier\": \"string | null\",\r\n\t\t\t\t\t\"availableCapacity\": Decimal | null\r\n\t\t\t\t},\r\n\t\t\t\t\"usageLookup\": bool,\r\n\t\t\t\t\"supplyAddress\": {\r\n\t\t\t\t\t\"udprn\": \"string | null\",\r\n\t\t\t\t\t\"mpxn\": \"string | null\",\r\n\t\t\t\t\t\"addressId\": \"string | null\",\r\n\t\t\t\t\t\"meterType\": 0, // Enum - 0 = Electricty, 1 = Gas\r\n\t\t\t\t\t\"additionalInformation\": \"string | null\",\r\n\t\t\t\t\t\"poBox\": \"string | null\",\r\n\t\t\t\t\t\"subBuilding\": \"string | null\",\r\n\t\t\t\t\t\"buildingName\": \"string | null\",\r\n\t\t\t\t\t\"buildingNumber\": \"string | null\",\r\n\t\t\t\t\t\"subStreet\": \"string | null\",\r\n\t\t\t\t\t\"street\": \"string | null\",\r\n\t\t\t\t\t\"subLocality\": \"string | null\",\r\n\t\t\t\t\t\"locality\": \"string | null\",\r\n\t\t\t\t\t\"town\": \"string | null\",\r\n\t\t\t\t\t\"county\": \"string | null\",\r\n\t\t\t\t\t\"postCode\": \"string | null\",\r\n\t\t\t\t\t\"currentSupplier\": \"string | null\",\r\n\t\t\t\t\t\"addressLine1\": \"string | null\",\r\n\t\t\t\t\t\"addressLine2\": \"string | null\",\r\n\t\t\t\t\t\"addressLine3\": \"string | null\"\r\n\t\t\t\t},\r\n\t\t\t\t\"rates\": {\r\n\t\t\t\t\t\"nightRate\": Decimal | null,\r\n\t\t\t\t\t\"eveningWeekendRate\": Decimal | null,\r\n\t\t\t\t\t\"dayRate\": Decimal | null,\r\n\t\t\t\t\t\"standingCharge\": Decimal | null\r\n\t\t\t\t},\r\n\t\t\t\t\"smartMeterInterest\": bool | null,\r\n\t\t\t\t\"uid\": \"string | null\"\r\n\t\t\t},\r\n\t\t\t\"companyData\": {\r\n\t\t\t\t\"companyName\": \"string | null\",\r\n\t\t\t\t\"companyNumber\": \"string | null\",\r\n\t\t\t\t\"creditScore\": int,\r\n\t\t\t\t\"companyType\": 0 // Enum - 0 = LTD, 1 = Charit, 3 = SoleTrader\r\n\t\t\t},\r\n\t\t\t\"email\": \"string | null\",\r\n\t\t\t\"firstName\": \"string | null\",\r\n\t\t\t\"surname\": \"string | null\",\r\n\t\t\t\"phoneNumber\": \"string | null\",\r\n\t\t\t\"estimatedCommission\": Decimal | null,\r\n\t\t\t\"upLift\": Decimal,\r\n\t\t\t\"termLength\": int,\r\n\t\t\t\"switchDetails\": {\r\n\t\t\t\t\"fuelType\": 0, // ENUM - 0 = Electricty, 1 = Gas\r\n\t\t\t\t\"registrationId\": null,\r\n\t\t\t\t\"registrationType\": \"string | null\",\r\n\t\t\t\t\"goLiveDate\": null,\r\n\t\t\t\t\"reapplicationDate\": null\r\n\t\t\t},\r\n\t\t\t\"switchStatus\": \"string | null\",\r\n\t\t\t\"quoteData\": {\r\n\t\t\t\t\"quoteId\": \"string | null\",\r\n\t\t\t\t\"estimatedAnnualCost\": Decimal | null\r\n\t\t\t}\r\n\t\t}\r\n\t],\r\n\t\"nextToken\": null,\r\n\t\"success\": true,\r\n\t\"status\": 200,\r\n\t\"messages\": [],\r\n\t\"errors\": [],\r\n\t\"timestamp\": \"2026-01-23T17:38:58.6871512Z\"\r\n}"}],"_postman_id":"010bcdaf-ea23-4612-86d7-cda425789156"},{"name":"All Journeys","id":"dd996842-724f-40ec-b3d4-2b99a4166f60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"endDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"nextToken\": \"string | null\",\r\n \"clientId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/journeys/v2/range/all","urlObject":{"path":["journeys","v2","range","all"],"host":["{{PULSE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"00f7fe0a-53ad-4b87-abe1-08944e01e4b2","name":"All Journeys","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{PULSE_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"endDate\": \"string\", // \"dd-MM-yyyy\"\r\n \"nextToken\": \"string | null\",\r\n \"clientId\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{PULSE_BASE_URL}}/journeys/v2/range/all"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"result\": [\r\n\t\t{\r\n\t\t\t\"fuelType\": \"string | null\",\r\n\t\t\t\"contractSignedDate\": \"string | null\",\r\n\t\t\t\"mpxn\": \"string | null\",\r\n\t\t\t\"contractStartDate\": \"string | null\",\r\n\t\t\t\"contractEndDate\": \"string | null\",\r\n\t\t\t\"affiliate\": \"string | null\",,\r\n\t\t\t\"creationType\": \"string | null\",\r\n\t\t\t\"creationTime\": \"string | null\",\r\n\t\t\t\"renewalQuoteUrl\": \"string | null\",,\r\n\t\t\t\"reapplicationDate\": \"string | null\",,\r\n\t\t\t\"supplyData\": {\r\n\t\t\t\t\"supplyType\": 0,\r\n\t\t\t\t\"startDate\": \"string | null\",\r\n\t\t\t\t\"usageDetails\": {\r\n\t\t\t\t\t\"mpxn\": \"string | null\",\r\n\t\t\t\t\t\"spend\": \"string | null\",\r\n\t\t\t\t\t\"energy\": \"string | null\",\r\n\t\t\t\t\t\"period\": 1, //Enum - 0 = Monthly, ` = Yearly\r\n\t\t\t\t\t\"eac\": \"string | null\",\r\n\t\t\t\t\t\"currentSupplier\": \"string | null\",\r\n\t\t\t\t\t\"availableCapacity\": Decimal | null\r\n\t\t\t\t},\r\n\t\t\t\t\"usageLookup\": bool,\r\n\t\t\t\t\"supplyAddress\": {\r\n\t\t\t\t\t\"udprn\": \"string | null\",\r\n\t\t\t\t\t\"mpxn\": \"string | null\",\r\n\t\t\t\t\t\"addressId\": \"string | null\",\r\n\t\t\t\t\t\"meterType\": 0, // Enum - 0 = Electricty, 1 = Gas\r\n\t\t\t\t\t\"additionalInformation\": \"string | null\",\r\n\t\t\t\t\t\"poBox\": \"string | null\",\r\n\t\t\t\t\t\"subBuilding\": \"string | null\",\r\n\t\t\t\t\t\"buildingName\": \"string | null\",\r\n\t\t\t\t\t\"buildingNumber\": \"string | null\",\r\n\t\t\t\t\t\"subStreet\": \"string | null\",\r\n\t\t\t\t\t\"street\": \"string | null\",\r\n\t\t\t\t\t\"subLocality\": \"string | null\",\r\n\t\t\t\t\t\"locality\": \"string | null\",\r\n\t\t\t\t\t\"town\": \"string | null\",\r\n\t\t\t\t\t\"county\": \"string | null\",\r\n\t\t\t\t\t\"postCode\": \"string | null\",\r\n\t\t\t\t\t\"currentSupplier\": \"string | null\",\r\n\t\t\t\t\t\"addressLine1\": \"string | null\",\r\n\t\t\t\t\t\"addressLine2\": \"string | null\",\r\n\t\t\t\t\t\"addressLine3\": \"string | null\"\r\n\t\t\t\t},\r\n\t\t\t\t\"rates\": {\r\n\t\t\t\t\t\"nightRate\": Decimal | null,\r\n\t\t\t\t\t\"eveningWeekendRate\": Decimal | null,\r\n\t\t\t\t\t\"dayRate\": Decimal | null,\r\n\t\t\t\t\t\"standingCharge\": Decimal | null\r\n\t\t\t\t},\r\n\t\t\t\t\"smartMeterInterest\": bool | null,\r\n\t\t\t\t\"uid\": \"string | null\"\r\n\t\t\t},\r\n\t\t\t\"companyData\": {\r\n\t\t\t\t\"companyName\": \"string | null\",\r\n\t\t\t\t\"companyNumber\": \"string | null\",\r\n\t\t\t\t\"creditScore\": int,\r\n\t\t\t\t\"companyType\": 0 // Enum - 0 = LTD, 1 = Charit, 3 = SoleTrader\r\n\t\t\t},\r\n\t\t\t\"email\": \"string | null\",\r\n\t\t\t\"firstName\": \"string | null\",\r\n\t\t\t\"surname\": \"string | null\",\r\n\t\t\t\"phoneNumber\": \"string | null\",\r\n\t\t\t\"estimatedCommission\": Decimal | null,\r\n\t\t\t\"upLift\": Decimal,\r\n\t\t\t\"termLength\": int,\r\n\t\t\t\"switchDetails\": {\r\n\t\t\t\t\"fuelType\": 0, // ENUM - 0 = Electricty, 1 = Gas\r\n\t\t\t\t\"registrationId\": null,\r\n\t\t\t\t\"registrationType\": \"string | null\",\r\n\t\t\t\t\"goLiveDate\": null,\r\n\t\t\t\t\"reapplicationDate\": null\r\n\t\t\t},\r\n\t\t\t\"switchStatus\": \"string | null\",\r\n\t\t\t\"quoteData\": {\r\n\t\t\t\t\"quoteId\": \"string | null\",\r\n\t\t\t\t\"estimatedAnnualCost\": Decimal | null\r\n\t\t\t}\r\n\t\t}\r\n\t],\r\n\t\"nextToken\": null,\r\n\t\"success\": true,\r\n\t\"status\": 200,\r\n\t\"messages\": [],\r\n\t\"errors\": [],\r\n\t\"timestamp\": \"2026-01-23T17:38:58.6871512Z\"\r\n}"}],"_postman_id":"dd996842-724f-40ec-b3d4-2b99a4166f60"}],"id":"3d4bdaf7-cb13-4a58-8b57-21cdef9bd152","description":"Leverage these endpoints to view all the journeys within a date range.
\nCompleted Journeys
\nCompleted journeys refer to journeys in which the customer has completed the registration / signed a contract.
\nAll Journeys
\nAll journeys refer to both incomplete and complete journeys, regardless of the stage the customer got to.
\nHeaders
\nx-api-key: supplied in supporting documentation.
\nAuthorization: retrieved via /auth/sign-in
\nParameters
\nstartDate: beginning of the date range, in the format dd-MM-yyyy.
\nendDate: end of the date range, in the format dd-MM-yyyy.
\nclientId: supplied in supporting documentation.
\nnextToken: This will be provided upon hitting the maximum number of journeys allowed to be returned per request.
\nIf the number of journeys within the specified date range exceeds the response limit, the endpoint will return journeys and also the nextToken. In this case, to retrieve the remaining journeys:
1. Keep the clientId, startDate and endDate the same as original
2. Add or update the nextToken in the request.
\n3. Repeat the request.
\nContinue this process until the nextToken is a null value.
\n","_postman_id":"3d4bdaf7-cb13-4a58-8b57-21cdef9bd152"}]}