---
updatedAt: 2025-06-05T21:49:13.000Z
agentTools:
  projectIndex: https://docs.cloudloop.com/llms.txt
---

# Get Subscriber

This endpoint will return the Subscriber identified by the supplied id; or alternatively the subscriber associated to the supplied imei.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "cloudloop",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.cloudloop.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "query",
        "name": "token"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/Sbd/GetSubscriber": {
      "get": {
        "summary": "Get Subscriber",
        "description": "",
        "operationId": "get-subscriber",
        "parameters": [
          {
            "name": "subscriber",
            "in": "query",
            "description": "cloudloop subscriber id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "imei",
            "in": "query",
            "description": "IMEI of Subscriber",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"subscriber\": {\n    \"createdAt\": \"2018-05-15T11:06:07\",\n    \"contract\": {\n            \"subscriber\": \"JYXyvGekqxMKAWvqNlnzbRDgVQZOwmdp\",\n            \"networkStatus\": \"ACTIVATED\",\n            \"committedTo\": \"2020-06-11T13:57:15\",\n            \"from\": \"2020-06-11T13:57:15\",\n            \"id\": \"KXeNzdgDqAwrAWbkaaExMLlmoGpaAARV\",\n            \"state\": \"NEW\",\n            \"to\": \"2021-06-11T13:57:15\",\n            \"plan\": {\n                \"feeMonthly\": 72.500,\n                \"inclusive\": 100000,\n                \"suspendible\": true,\n                \"description\": \"100P Standard Plan\",\n                \"increment\": 1,\n                \"commitment\": 12,\n                \"pooled\": true,\n                \"terminationFee\": 0.000,\n                \"terminable\": false,\n                \"name\": \"CLOUDLOOP_SBD_100P\",\n                \"id\": \"pjvzwyOMVbPZgeWAARnaYaQAAJGxkKLr\"\n            },\n    \"destinations\": [],\n    \"billingGroup\": \"aYAlaXzwrdjambEKYanKLNxvPkMeqgid\",\n    \"name\": \"Test Subscriber\",\n    \"description\": \"Series X\",\n    \"id\": \"JYXyvGekqxMKAWvqNlnzbRDgVQZOwmdp\",\n    \"account\": \"LyjrgkpAemZqGBRNZwBRvNVKxQPXdYoO\",\n    \"hardware\": {\n      \"imei\": \"123456789012345\",\n      \"id\": \"pwjgJyDQqreRknxoOyBAGYmVlazNdOMX\",\n      \"type\": \"IRIDIUM_SBD\"\n    }\n  }\n}"
                  },
                  "OK - With Contract": {
                    "value": "{\n  \"subscriber\": {\n    \"createdAt\": \"2018-05-15T11:06:07\",\n    \"contract\": {\n      \"subscriber\": \"meJwgzdpXVxNRnoXNzWMDlQGLPvAbkyr\",\n      \"networkStatus\": \"ACTIVATING\",\n      \"from\": \"2018-05-15T11:06:07\",\n      \"id\": \"wbpYqLdxyzVrAEYyKZEQmgRMjGOvoeZk\",\n      \"state\": \"NEW\",\n      \"to\": null\n    },\n    \"destinations\": [],\n    \"name\": \"Test Subscriber\",\n    \"id\": \"meJwgzdpXVxNRnoXNzWMDlQGLPvAbkyr\",\n    \"account\": \"OVdRorbmlwqkNBpNymWJYPZvxaXpzjLg\",\n    \"hardware\": {\n      \"imei\": \"123456789012345\",\n      \"id\": \"orLzVjdQqPgkaElpmbEpRyKbJZONAGYD\",\n      \"type\": \"IRIDIUM_SBD\"\n    }\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "subscriber": {
                      "type": "object",
                      "properties": {
                        "createdAt": {
                          "type": "string",
                          "example": "2018-05-15T11:06:07"
                        },
                        "contract": {
                          "type": "object",
                          "properties": {
                            "subscriber": {
                              "type": "string",
                              "example": "meJwgzdpXVxNRnoXNzWMDlQGLPvAbkyr"
                            },
                            "networkStatus": {
                              "type": "string",
                              "example": "ACTIVATING"
                            },
                            "from": {
                              "type": "string",
                              "example": "2018-05-15T11:06:07"
                            },
                            "id": {
                              "type": "string",
                              "example": "wbpYqLdxyzVrAEYyKZEQmgRMjGOvoeZk"
                            },
                            "state": {
                              "type": "string",
                              "example": "NEW"
                            },
                            "to": {}
                          }
                        },
                        "destinations": {
                          "type": "array"
                        },
                        "name": {
                          "type": "string",
                          "example": "Test Subscriber"
                        },
                        "id": {
                          "type": "string",
                          "example": "meJwgzdpXVxNRnoXNzWMDlQGLPvAbkyr"
                        },
                        "account": {
                          "type": "string",
                          "example": "OVdRorbmlwqkNBpNymWJYPZvxaXpzjLg"
                        },
                        "hardware": {
                          "type": "object",
                          "properties": {
                            "imei": {
                              "type": "string",
                              "example": "123456789012345"
                            },
                            "id": {
                              "type": "string",
                              "example": "orLzVjdQqPgkaElpmbEpRyKbJZONAGYD"
                            },
                            "type": {
                              "type": "string",
                              "example": "IRIDIUM_SBD"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```