IoT Portal Core API
\nNote: some routes are not available for certain provider networks
\nRoot URL: https://api.iotportal.io/api/
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32987415","collectionId":"006fd082-37ab-44cf-9769-814aee827f37","publishedId":"2sB2cPi5D4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"242a4d","highlight":"00d5a1"},"publishDate":"2025-07-15T15:14:03.000Z"},"item":[{"name":"AUTH","item":[{"name":"Core Login","id":"dc4882c4-ad50-463a-84c4-433cd6db9f78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"apiToken\": \"{{coreKey}}\"\n}","options":{"raw":{"language":"json"}}},"url":"/Login","description":"Login request via api token.
\nPLEASE USE ACCOUNT LOGIN BELOW.
\n","urlObject":{"path":["Login"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"dc4882c4-ad50-463a-84c4-433cd6db9f78"},{"name":"Account Login","id":"07fce89a-2382-4019-9711-e369d4d9521f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"clientId\": \"{{clientId}}\",\n\t\"secretKey\": \"{{secretKey}}\"\n}","options":{"raw":{"language":"json"}}},"url":"/Login","description":"Login request via customer id/key. You will be returned a token:
\n{\n \"data\": {\n \"token\": \"xxxxxx\"\n }\n}\n\nAuthentication for the portal
\n","_postman_id":"0333a378-18cb-44bc-a421-2480b040ccfe"},{"name":"Queries","item":[{"name":"CTD Usage","id":"e13b6b02-da24-410e-9fc1-ad9af2c871ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/ctdUsage/{{ICCID}}","description":"Retrieve current usage for a SIM
\n","urlObject":{"path":["ctdUsage","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"92f45bd7-c0ab-41b5-bfef-85228607ac1a","name":"CTD Usage","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/ctdUsage/{{ICCID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Jan 2025 10:26:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"Jetty(9.4.53.v20231009)"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"iccid\": \"8931082322089353632\",\n \"imsi\": \"204080823514892\",\n \"msisdn\": \"3197044863841\",\n \"imei\": \"8613300585142338\",\n \"status\": \"INVENTORY\",\n \"ctdDataUsage\": 0,\n \"ctdSMSUsage\": 0,\n \"ctdVoiceUsage\": 0,\n \"ctdSessionCount\": null\n }\n]"}],"_postman_id":"e13b6b02-da24-410e-9fc1-ad9af2c871ec"},{"name":"Get Device","id":"19880c81-16fe-4160-9d38-3d9d48833317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/GetDevice/{{ICCID}}","description":"Retrieve information for a SIM
\n","urlObject":{"path":["GetDevice","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"bf2497db-decd-4a1e-98b1-3b514fb115cb","name":"Get Device","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/GetDevice/{{ICCID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Jan 2025 10:26:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"Jetty(9.4.53.v20231009)"}],"cookie":[],"responseTime":null,"body":"{\n \"iccid\": \"8931082322089353632\",\n \"imsi\": \"204080823514892\",\n \"msisdn\": \"3197044863841\",\n \"imei\": \"8613300585142338\",\n \"status\": \"INVENTORY\",\n \"ratePlan\": \"Pangea EU Economy 300MB\",\n \"communicationPlan\": \"Pangea EU (pkp18-inet) DATA SMS Voice\",\n \"customer\": \"#8941 Pangea Retired\",\n \"endConsumerId\": null,\n \"dateActivated\": \"2023-06-23 11:14:37.998+0000\",\n \"dateCreated\": \"2022-10-17 13:06:14.364+0000\",\n \"dateUpdated\": \"2023-08-16 11:35:10.351+0000\",\n \"dateShipped\": \"2023-02-19 23:00:00.000+0000\",\n \"accountId\": \"100096903\",\n \"fixedIPAddress\": null,\n \"simNotes\": null,\n \"deviceID\": \"Pangea test SIM\",\n \"modemID\": null,\n \"globalSimType\": \"NONE\",\n \"username\": \"\",\n \"commsplan\": \"MULTINETWORK\",\n \"isshared\": \"False\",\n \"parenticcid\": \"\",\n \"dataquantity\": \"1\",\n \"datasize\": \"GB\",\n \"action\": \"\",\n \"zh_q_id\": \"test12345\",\n \"contractdetails\": \"1-Current\"\n}"}],"_postman_id":"19880c81-16fe-4160-9d38-3d9d48833317"},{"name":"Get Session Info","id":"5a02d123-2246-450a-a1b5-671258244eb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/sessionInfo/{{ICCID}}","description":"Retrieve the most recent session information for a SIM
\n","urlObject":{"path":["sessionInfo","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a0459330-991a-4685-a946-6059ea9f63fd","name":"Get Session Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/sessionInfo/{{ICCID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Jan 2025 10:27:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"Jetty(9.4.53.v20231009)"}],"cookie":[],"responseTime":null,"body":"{\n \"iccid\": \"8931082322089353632\",\n \"ipAddress\": \"100.126.61.98\",\n \"dateSessionStarted\": \"2023-08-16 10:50:07.220+0000\",\n \"dateSessionEnded\": \"2023-08-16 10:50:07.220+0000\"\n}"}],"_postman_id":"5a02d123-2246-450a-a1b5-671258244eb9"},{"name":"Get SMS","id":"90e9735d-ab73-4e75-9e1d-19a1ad346e43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/GetSMS/{{SMS_id}}","description":"Retrieve information about an SMS message sent to a SIM
\n","urlObject":{"path":["GetSMS","{{SMS_id}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"90e9735d-ab73-4e75-9e1d-19a1ad346e43"},{"name":"Get SMS Ids","id":"072c4ad3-ef20-4c0a-9f87-edb60eb2e873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/GetSMSIds/{{ICCID}}","description":"Retrieve IDs of SMS messages sent to a SIM
\n","urlObject":{"path":["GetSMSIds","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"072c4ad3-ef20-4c0a-9f87-edb60eb2e873"},{"name":"Get Status","id":"5dbd61ce-6dd7-444b-be53-cb23ea8c4b69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/getStatus/{{ICCID}}","description":"Retrieve the current status of a SIM
\n","urlObject":{"path":["getStatus","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d63f9f18-ab26-4293-aa7b-06f1e5a74b1d","name":"Get Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/getStatus/{{ICCID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Jan 2025 10:27:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"server","value":"Jetty(9.4.53.v20231009)"}],"cookie":[],"responseTime":null,"body":"INVENTORY"}],"_postman_id":"5dbd61ce-6dd7-444b-be53-cb23ea8c4b69"},{"name":"Get Status (Abzorb)","id":"076e98b5-53d4-4413-af86-6934d516a6be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"url":"/getStatus/{{ICCID}}","description":"Retrieve the current status of an Abzorb network SIM
\n","urlObject":{"path":["getStatus","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"076e98b5-53d4-4413-af86-6934d516a6be"}],"id":"d797e6e6-7b7e-40d3-a95d-0b1602fd9b54","description":"Informational queries for the IoT Portal SIM estate
\n","_postman_id":"d797e6e6-7b7e-40d3-a95d-0b1602fd9b54"},{"name":"Mutations","item":[{"name":"Bulk Edit Device","id":"e1b7e67d-5f1a-4368-b815-fc5bb7f44b64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"update\": {\n \"status\": \"ACTIVATED\"\n },\n \"queueId\": \"1234\",\n \"webhookUrl\": \"https://b54d-102-132-147-217.ngrok-free.app/ping\",\n \"iccids\": [\"{{ICCID}}\"]\n}","options":{"raw":{"language":"json"}}},"url":"/BulkEditDevice","description":"Edit multiple SIMs in a single request. This request will be queued and its status viewed in the IoT Portal.
\nMOST ACCOUNTS WILL NOT HAVE ACCESS TO THIS ROUTE
\n","urlObject":{"path":["BulkEditDevice"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e1b7e67d-5f1a-4368-b815-fc5bb7f44b64"},{"name":"Edit Device","id":"f49d6ace-3184-4af4-b9c6-0b256761c8ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"ACTIVATED\"\n}","options":{"raw":{"language":"json"}}},"url":"/EditDevice/{{ICCID}}","description":"Edit a single SIM
\nMOST ACCOUNTS WILL NOT HAVE ACCESS TO THIS ROUTE
\n","urlObject":{"path":["EditDevice","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f49d6ace-3184-4af4-b9c6-0b256761c8ce"},{"name":"Request Status Change","id":"bfa29eb2-0769-4548-bb57-82d708620bdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"ACTIVATED\"\n}","options":{"raw":{"language":"json"}}},"url":"/RequestStatusChange/{{ICCID}}","description":"Request a status change for a SIM
\n","urlObject":{"path":["RequestStatusChange","{{ICCID}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"bfa29eb2-0769-4548-bb57-82d708620bdb"},{"name":"Send SMS","id":"a417081a-4103-472f-8514-1457ff6f870c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messageText\": \"Hello\"\n}","options":{"raw":{"language":"json"}}},"url":"/SendSMS/{{ICCID}}/{{apiVersion}}","description":"Send an SMS message to a SIM
\n","urlObject":{"path":["SendSMS","{{ICCID}}","{{apiVersion}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a417081a-4103-472f-8514-1457ff6f870c"},{"name":"RuleUpdate","id":"c0b99cfe-2a3d-47a9-a178-2816ef63ff21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{AUTH_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}","options":{"raw":{"language":"json"}}},"url":"/RuleUpdate","urlObject":{"path":["RuleUpdate"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c0b99cfe-2a3d-47a9-a178-2816ef63ff21"}],"id":"80a11857-74a0-4a95-a991-9b975d9165a1","description":"Change requests for the IoT Portal SIM estate
\n","event":[{"listen":"prerequest","script":{"id":"38f0cce7-6ca2-48e4-9dab-cbce996edaf0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"604203ca-a222-489a-839d-9689d9170818","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"80a11857-74a0-4a95-a991-9b975d9165a1"}],"variable":[{"key":"URL","value":"","type":"default"}]}