{"info":{"_postman_id":"44b2954c-6b09-4b0b-8a3f-f1ed990550af","name":"Jellyfish Energy - Ephyra API","description":"

The official documentation for Jellyfish Energy Core which allows you to access all information available on your account as well as some global endpoints.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9702688","collectionId":"44b2954c-6b09-4b0b-8a3f-f1ed990550af","publishedId":"SWE3dzVu","public":true,"customColor":{"top-bar":"ffffff","right-sidebar":"2B2B2B","highlight":"2EAF5F"},"publishDate":"2023-07-14T14:20:56.000Z"},"item":[{"name":"Authorisation","item":[{"name":"Magic Links","item":[{"name":"/auth/token","id":"a7cadac1-618a-42da-9761-f5f59ac86bcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": \"07477705433\",\n \"type\": \"phone\",\n \"callback\": \"jellyfish://\"\n}"},"url":"{{API_URL}}auth/token","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
user	string	This will accept a valid account mobile number or email address.
type	string	This will accept \"phone\" or \"email\" and should match what type is specified in the \"user\" parameter.
callback	string	URL to be called upon successful token you will then need to call the \"/auth/redeem/:token\" endpoint.

","urlObject":{"path":["token"],"host":["{{API_URL}}auth"],"query":[],"variable":[]}},"response":[{"id":"6fd1e28b-82a9-4a5e-b59f-454b8529c2fc","name":"/auth/token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\": \"demo@jellyfish.energy\",\n \"type\": \"email\",\n \"callback\": \"jellyfish://\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}auth/token"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"errors\": null\n}"}],"_postman_id":"a7cadac1-618a-42da-9761-f5f59ac86bcb"},{"name":"/auth/redeem/:key","id":"fbefaa2d-3088-4e4c-ab15-c29910208250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{API_URL}}auth/redeem/{{MAGIC_KEY}}","urlObject":{"path":["redeem","{{MAGIC_KEY}}"],"host":["{{API_URL}}auth"],"query":[],"variable":[]}},"response":[{"id":"950ccd2e-bff9-4088-9edb-d2325baad4c4","name":"/auth/redeem/:key","originalRequest":{"method":"GET","header":[],"url":"{{API_URL}}auth/redeem/{{MAGIC_KEY}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": \"JWT_TOKEN\",\n \"errors\": null\n}"}],"_postman_id":"fbefaa2d-3088-4e4c-ab15-c29910208250"}],"id":"28e16f94-4543-4553-a350-f83985b294a4","description":"

We utilise a passwordless way to authenticate with our platform. Using the methods below you may request and redeem by magic link or code.

\n","event":[{"listen":"prerequest","script":{"id":"efb2d0e1-b72c-4c22-98c2-deb59e0fae2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a61279f8-5187-457d-abf6-26f32b95139f","type":"text/javascript","exec":[""]}}],"_postman_id":"28e16f94-4543-4553-a350-f83985b294a4"},{"name":"/auth/check","id":"62493ea5-ed32-4f7d-a06d-ba9d259f8750","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}auth/check","urlObject":{"path":["check"],"host":["{{API_URL}}auth"],"query":[],"variable":[]}},"response":[{"id":"6cbb6785-45b1-4cec-924e-4db35b469edd","name":"/auth/check","originalRequest":{"method":"GET","header":[],"url":"{{API_URL}}auth/check"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"errors\": null\n}"}],"_postman_id":"62493ea5-ed32-4f7d-a06d-ba9d259f8750"}],"id":"55621c95-9306-4884-941f-8fc7513f016a","description":"

To authorize with the API so that certain protected routes become available you must obtain a token via magic link or use a service account.

\n","event":[{"listen":"prerequest","script":{"id":"37c2b438-c769-4ca0-bca3-22392c0fe6a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d55f518f-51ae-4b76-8fa6-9bda019c8a26","type":"text/javascript","exec":[""]}}],"_postman_id":"55621c95-9306-4884-941f-8fc7513f016a"},{"name":"Accounts","item":[{"name":"Account","item":[{"name":"/accounts/:id/no-token","id":"8d608be4-5392-4872-9045-c3898c18c1c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"postcode\": \"NE4 7DF\",\n \"email\": \"hello@jellyfish.energy\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/no-token","urlObject":{"path":["{{ACCOUNT_ID}}","no-token"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d608be4-5392-4872-9045-c3898c18c1c8"},{"name":"/accounts/:id/balance","id":"74204816-f0c0-47e6-b557-18a7558d2154","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/balance","urlObject":{"path":["{{ACCOUNT_ID}}","balance"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"74204816-f0c0-47e6-b557-18a7558d2154"},{"name":"/accounts/:id/mandate","id":"d602bd02-ca53-4d96-815a-e010cf9afa83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/mandate","urlObject":{"path":["{{ACCOUNT_ID}}","mandate"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"d602bd02-ca53-4d96-815a-e010cf9afa83"},{"name":"/accounts/:id/reads","id":"c5feb58f-9dbb-4686-bea7-99fb28b4a10c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/reads","urlObject":{"path":["{{ACCOUNT_ID}}","reads"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5feb58f-9dbb-4686-bea7-99fb28b4a10c"},{"name":"/accounts/:id/reads","id":"b551249d-cdf1-4852-9a94-b35773f49b30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/reads","urlObject":{"path":["{{ACCOUNT_ID}}","reads"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"b551249d-cdf1-4852-9a94-b35773f49b30"},{"name":"/accounts/:id/reads/next-due","id":"498abed8-30ff-491d-9236-5a185fbf217b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/reads/next-due","urlObject":{"path":["{{ACCOUNT_ID}}","reads","next-due"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"498abed8-30ff-491d-9236-5a185fbf217b"},{"name":"/accounts/:id/payments","id":"7f5385b1-8f37-4c39-8710-78ab1a7387f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/payments","urlObject":{"path":["{{ACCOUNT_ID}}","payments"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f5385b1-8f37-4c39-8710-78ab1a7387f9"},{"name":"/accounts/:id/bills","id":"6b4e000b-6b69-40ac-b740-63bff5d31038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/bills","urlObject":{"path":["{{ACCOUNT_ID}}","bills"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b4e000b-6b69-40ac-b740-63bff5d31038"},{"name":"/accounts/:id/bills/last-bill","id":"98a5aae7-4f2e-4f61-af8d-c7915c1ab733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/bills/last-bill","urlObject":{"path":["{{ACCOUNT_ID}}","bills","last-bill"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"98a5aae7-4f2e-4f61-af8d-c7915c1ab733"},{"name":"/accounts/:id/bills/next-due","id":"7227c7b3-e628-4022-a4bf-705b46e4a564","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/bills/next-due","urlObject":{"path":["{{ACCOUNT_ID}}","bills","next-due"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"7227c7b3-e628-4022-a4bf-705b46e4a564"},{"name":"/accounts/:id/bills/:bill","id":"e109083d-92f3-4409-8f6d-fd70d6f5130f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/bills/123","urlObject":{"path":["{{ACCOUNT_ID}}","bills","123"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"e109083d-92f3-4409-8f6d-fd70d6f5130f"},{"name":"/accounts/:id/rating","id":"9d3edcf4-3fc7-4ffd-9d4a-9378c8a53610","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/rating","urlObject":{"path":["{{ACCOUNT_ID}}","rating"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d3edcf4-3fc7-4ffd-9d4a-9378c8a53610"},{"name":"/accounts/:id/plan","id":"4fedb11f-d816-4a9d-9761-e3cb30c71ada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/plan","urlObject":{"path":["{{ACCOUNT_ID}}","plan"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fedb11f-d816-4a9d-9761-e3cb30c71ada"},{"name":"/accounts/:id/meters","id":"123cb321-ddea-4779-aa81-23afb2bda365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/meters","urlObject":{"path":["{{ACCOUNT_ID}}","meters"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"123cb321-ddea-4779-aa81-23afb2bda365"},{"name":"/accounts/:id/contact","id":"98059a30-43a7-4568-86f4-f6cdc9db8b1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/contact","urlObject":{"path":["{{ACCOUNT_ID}}","contact"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"98059a30-43a7-4568-86f4-f6cdc9db8b1f"},{"name":"/accounts/:id/bank-details","id":"dafcc513-8932-4b55-8f73-8ab205b80bfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{API_URL}}accounts/{{ACCOUNT_ID}}/bank-details","urlObject":{"path":["{{ACCOUNT_ID}}","bank-details"],"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"dafcc513-8932-4b55-8f73-8ab205b80bfa"}],"id":"f9cdb24d-b73f-4d3c-b2b6-e2c96def911b","_postman_id":"f9cdb24d-b73f-4d3c-b2b6-e2c96def911b","description":""},{"name":"/accounts","id":"bc2ef920-3f88-4b23-801e-9aa91ba7a739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}accounts","urlObject":{"host":["{{API_URL}}accounts"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc2ef920-3f88-4b23-801e-9aa91ba7a739"}],"id":"419078f3-9c19-42f5-8cff-ecef94ea88cd","_postman_id":"419078f3-9c19-42f5-8cff-ecef94ea88cd","description":""}],"event":[{"listen":"prerequest","script":{"id":"ab3eb015-2f61-4851-9388-66f3a98e6929","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b46ffa7c-0b7e-4b72-93c9-cf211585970c","type":"text/javascript","exec":[""]}}]}