> This page is for Developers. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.emnify.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.emnify.com/_mcp/server. > Endpoint API reference with JSON object schemas for device management including status, service profiles, tariff profiles, and SIM data. The API provides services to retrieve the collection of endpoints with paging, filtering, and sorting options. It also provides services for single endpoint retrieval and CRUD operations via `POST`, `PATCH`, and `DELETE` actions. The following is a sample endpoint in JSON representation. Apart from the endpoint-specific data, it contains the following embedded objects: * `tag_assignments` * `service_profile` * `tariff_profile` * `sim` * `runtime_data` ```json maxLines=15 { "id": 1, "name": "arduino01", "tags": "arduino, meter, temp", "tag_assignments": [ { "id": 1, "name": "arduino", "tag_color": { "id": 3 } }, { "id": 2, "name": "meter", "tag_color": { "id": 5 } }, { "id": 3, "name": "temp", "tag_color": { "id": 7 } } ], "created": "2014-08-01T08:47:00+00:00", "last_updated": "2016-03-02T15:25:34.000+0000", "status": { "id": 0, "description": "Enabled" }, "service_profile": { "id": 1, "name": "Smart Meter" }, "tariff_profile": { "id": 3, "name": "Domestic only" }, "sim": { "id": 788, "iccid": "7368267364738977362", "iccid_with_luhn": "73682673647389773621", "eid": "89049011803455664400046832584675", "imsi": "901991234567890", "msisdn": "88563748761", "status": { "id": 1, "description": "Activated" } }, "runtime_data": { "msc": "491790802121", "sgsn": "491752345678", "sgsn_ip_address": "82.113.96.21" }, "imei": "8643456788893212", "imei_with_luhn": "864345678889324", "ip_address": "10.2.1.1", "ip_address_space": { "id": 2, "ip_address_space": "10.2.0.0/16", "ip_address_version": 4 }, "imei_lock": true } ``` ## Endpoint object The endpoint object has the following properties: | Name | Type | Description | | :----------------- | :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | Integer | Unique identifier of this endpoint | | `name` | String | Name of endpoint | | `tags` | String \| `null` | *Deprecated, use `tag_assignments`.* Any tags assigned to this endpoint with each value separated by a comma (for example, `"arduino, meter, temp"`) | | `tag_assignments` | Array | Tags assigned to this endpoint, including their color (see [Tag assignment object](#tag-assignment-object)) | | `created` | Timestamp | Date/time when this endpoint was created *Type: ISO 8601 timestamp format* | | `last_updated` | Timestamp | Date/time when this endpoint was last updated *Type: ISO 8601 timestamp format* | | `status` | Object | Information about the [endpoint status](https://www.emnify.com/iot-glossary#device-status) (see [Endpoint status object](#endpoint-status-object)) | | `service_profile` | Object \| `null` | Details about the assigned [service profile](https://www.emnify.com/iot-glossary#service-profile) (see [Service profile object](#service-profile-object)) | | `tariff_profile` | Object \| `null` | Details about the assigned tariff profile (see [Tariff profile object](#tariff-profile-object)) | | `sim` | Object \| `null` | Information about the SIM card used by the endpoint (see [SIM object](#sim-object)) | | `runtime_data` | Object | Information about the runtime data for this endpoint (see [Runtime data object](#runtime-data-object)) | | `imei` | String \| `null` | 16-digit international mobile equipment identity without the check digit. The last two digits identify the Software Version Number (SVN). | | `imei_with_luhn` | String \| `null` | 15-digit international mobile equipment identity. The last digit contains the [check digit](https://www.emnify.com/iot-glossary#check-digit). | | `ip_address` | String | Configured IP address | | `ip_address_space` | Object | Information about the assigned IP address space (see [IP Address Space Object](#ip-address-space-object)) | | `imei_lock` | Boolean | Whether or not the endpoint is locked to the current [IMEI](https://www.emnify.com/iot-glossary#imei) (learn more about the [IMEI lock](https://www.emnify.com/iot-glossary#imei-lock)) | ### Tag assignment object | Property | Type | Description | | :---------- | :------ | :------------------------------------------------ | | `id` | Integer | Unique identifier of the tag | | `name` | String | Name of the tag | | `tag_color` | Object | Color of the tag, as an object with an `id` field | ### Endpoint status object | Property | Type | Description | | :------------ | :------ | :--------------------------------- | | `id` | Integer | Status ID for this endpoint | | `description` | String | Description of the endpoint status | #### Endpoint statuses | ID | Description | | :- | :---------- | | 0 | Enabled | | 1 | Disabled | | 2 | Deleted | ### Service profile object > **Info** > > This data is embedded from a subset of the [Service profile](/developers/reference/service-profile). | Property | Type | Description | | :------- | :----- | :------------------------------------------------ | | `id` | Number | Unique identifier of the assigned service profile | | `name` | String | Name of the service profile | ### Tariff profile object > **Info** > > This data is embedded from a subset of the [Tariff profile](/developers/reference/tariff-profile). | Property | Type | Description | | :------- | :----- | :----------------------------------------------- | | `id` | Number | Unique identifier of the assigned tariff profile | | `name` | String | Name of the tariff profile | ### SIM Object > **Info** > > This data is embedded from a subset of the [SIM](/developers/reference/sim). | Property | Type | Description | | :---------------- | :--------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | Integer | Unique identifier of this SIM | | `iccid` | String | [Integrated circuit card identifier](https://www.emnify.com/iot-glossary#iccid) *without* the final [Luhn checksum digit](https://www.emnify.com/iot-glossary#luhn-checksum-digit) | | `iccid_with_luhn` | String | Integrated circuit card identifier *including* the final Luhn checksum digit | | `eid` | String | Unique global serial number for an [eUICC](https://www.emnify.com/iot-glossary#euicc) if applicable ([learn more about the EID](https://www.emnify.com/iot-glossary#eid)) | | `imsi` | String \| `null` | Currently active [IMSI](https://www.emnify.com/iot-glossary#imsi) number of this SIM | | `msisdn` | String \| `null` | [Mobile Station International Subscriber Directory Number (MSISDN)](https://www.emnify.com/iot-glossary#msisdn) assigned to this SIM | | `status` | Object | Information about the [SIM status](https://www.emnify.com/iot-glossary#sim-status) (see [SIM status object](/developers/reference/sim#sim-status-object)) | ### Runtime data object | Property | Type | Description | | :---------------- | :----- | :-------------------------------------------------------------------------------------------- | | `msc` | String | Global title of the [MSC](https://www.emnify.com/iot-glossary#msc) connected to this endpoint | | `sgsn` | String | Global title of the serving GPRS support node (SGSN) | | `sgsn_ip_address` | String | IP of the SGSN currently serving this endpoint | ### IP address space object | Property | Type | Description | | :------------------- | :------ | :------------------------------------------------------------------------------ | | `id` | Integer | Unique identifier of the assigned IP address space | | `ip_address_space` | String | [Subnet](https://www.emnify.com/iot-glossary#ip-subnet) of the IP address space | | `ip_address_version` | Integer | IP version for this address space (for example, `4` or `6`) |