Retrieve a service profile

GET

https://cdn.emnify.net/api/v1/service_profile/:profile_id

GET

/api/v1/service_profile/:profile_id

curl https://cdn.emnify.net/api/v1/service_profile/1.1 \
     -H "Authorization: Bearer <token>"

{
  "id": 232,
  "name": "Smart meter",
  "description": "Data + SMS - 1G limit",
  "allowed_3g": true,
  "allowed_4g": true,
  "allowed_nb_iot": true,
  "allowed_nb_iot_geo": false,
  "apply_sms_quota": false,
  "apply_data_quota": false,
  "retail": false,
  "sms_p2p_int": true,
  "sms_p2p_ext": true,
  "nipdp": false,
  "used_count": 12,
  "api_callback": {
    "created": "2019-03-18T16:11:07.000Z",
    "id": 38,
    "purpose": "Customer's Webserver",
    "url": "https://www.customers-server.com"
  },
  "api_secret": {
    "id": 38,
    "purpose": "K3"
  },
  "moc_callback": {
    "created": "2019-03-18T16:11:17.000Z",
    "id": 39,
    "purpose": "Customer's Moc server",
    "url": "https://moc.customers-server.com"
  },
  "esme_interface_type": {
    "description": "Console",
    "id": 3
  },
  "breakout_region": {
    "id": 3,
    "ip_address": "0.0.0.0",
    "name": "eu-west-1 (VPN)"
  },
  "service": [
    {
      "description": "Data",
      "id": 123,
      "teleservice_code": 7678345,
      "traffic_limit": [
        {
          "id": 123,
          "period": {
            "id": 33,
            "time_units": 5,
            "unit": "Days"
          },
          "volume": 64
        },
        {
          "id": 234,
          "period": {
            "id": 35,
            "time_units": 1,
            "unit": "Months"
          },
          "volume": 128
        }
      ],
      "traffic_type": {
        "description": "Data",
        "id": 1,
        "unit": "GB"
      }
    }
  ],
  "ip_firewall_rule_set": {
    "ip_firewall_profiles": [
      {
        "id": 43,
        "name": "Default Inbound Block",
        "added": "2026-04-09T11:12:45+00:00"
      }
    ],
    "enforce": true
  },
  "dns_firewall_rule_set": {
    "dns_firewall_profiles": [
      {
        "id": 10,
        "name": "Corporate DNS Policy",
        "added": "2026-07-07T08:15:00+00:00"
      }
    ],
    "enforce": true,
    "mode": "whitelist"
  }
}

ServiceProfile + Get

Roles: Administrator User Observer

Retrieve a service profile with a given id.

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `ServiceProfile` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> Retrieve a service profile with a given id.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

profile_iddoubleRequired

The Numeric ID of a Service Profile

Response

Success

idintegerOptional

namestringOptional

descriptionstringOptional

allowed_3gbooleanOptional

allowed_4gbooleanOptional

allowed_nb_iotbooleanOptional

allowed_nb_iot_geobooleanOptional

apply_sms_quotabooleanOptional

apply_data_quotabooleanOptional

retailbooleanOptional

sms_p2p_intbooleanOptional

sms_p2p_extbooleanOptional

prepaidbooleanOptional

nipdpbooleanOptional

used_countintegerOptional

api_callbackobjectOptional

api_secretobjectOptional

moc_callbackobjectOptional

esme_interface_typeobjectOptional

breakout_regionobjectOptional

servicelist of objectsOptional

ip_firewall_rule_setobjectOptional

dns_firewall_rule_setobjectOptional

Errors

403

Forbidden Error