List endpoints

GET

https://cdn.emnify.net/api/v1/endpoint

GET

/api/v1/endpoint

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

200Default - List All Endpoints

1 [
2   {
3     "status": {
4       "id": 0,
5       "description": "Enabled"
6     },
7     "tariff_profile": {
8       "id": 100,
9       "name": "Global IoT Plan"
10     },
11     "service_profile": {
12       "id": 200,
13       "name": "Standard IoT"
14     },
15     "id": 1,
16     "created": "2024-01-15T10:30:00.000+0000",
17     "last_updated": "2024-06-20T14:45:00.000+0000",
18     "name": "Weather Station 01",
19     "tags": "sensor,outdoor,weather",
20     "ip_address": "10.0.0.1",
21     "imei": "3561234567890123",
22     "imei_lock": true,
23     "tag_assignments": [
24       {
25         "id": 1,
26         "name": "sensor",
27         "tag_color": {
28           "id": 3
29         }
30       },
31       {
32         "id": 2,
33         "name": "outdoor",
34         "tag_color": {
35           "id": 5
36         }
37       },
38       {
39         "id": 3,
40         "name": "weather",
41         "tag_color": {
42           "id": 7
43         }
44       }
45     ],
46     "sim": {
47       "id": 500,
48       "iccid": "8988303000001234567",
49       "iccid_with_luhn": "89883030000012345671",
50       "status": {
51         "id": 1,
52         "description": "Activated"
53       },
54       "imsi": "901430001234567",
55       "msisdn": "882850001234567",
56       "sim_profile_type": {
57         "id": 1
58       }
59     },
60     "ip_address_space": {
61       "id": 1
62     },
63     "imei_with_luhn": "356123456789012"
64   }
65 ]

Retrieves all endpoints for your organization. Use the query parameters to filter, sort, and paginate results.

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

[
  {
    "status": {
      "id": 0,
      "description": "Enabled"
    },
    "tariff_profile": {
      "id": 100,
      "name": "Global IoT Plan"
    },
    "service_profile": {
      "id": 200,
      "name": "Standard IoT"
    },
    "id": 1,
    "created": "2024-01-15T10:30:00.000+0000",
    "last_updated": "2024-06-20T14:45:00.000+0000",
    "name": "Weather Station 01",
    "tags": "sensor,outdoor,weather",
    "ip_address": "10.0.0.1",
    "imei": "3561234567890123",
    "imei_lock": true,
    "tag_assignments": [
      {
        "id": 1,
        "name": "sensor",
        "tag_color": {
          "id": 3
        }
      },
      {
        "id": 2,
        "name": "outdoor",
        "tag_color": {
          "id": 5
        }
      },
      {
        "id": 3,
        "name": "weather",
        "tag_color": {
          "id": 7
        }
      }
    ],
    "sim": {
      "id": 500,
      "iccid": "8988303000001234567",
      "iccid_with_luhn": "89883030000012345671",
      "status": {
        "id": 1,
        "description": "Activated"
      },
      "imsi": "901430001234567",
      "msisdn": "882850001234567",
      "sim_profile_type": {
        "id": 1
      }
    },
    "ip_address_space": {
      "id": 1
    },
    "imei_with_luhn": "356123456789012"
  }
]

Retrieves all endpoints for your organization. Use the query parameters to filter, sort, and paginate results.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

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

Query parameters

qstringOptional

format: "(status|service_profile|tariff_profile|id|name|created|last_updated|tags|ip_address|imei|iccid|iccid_with_luhn|eid|sim_status):.+"

Filters endpoints by field value. Use <field>:<criteria> format. Combine multiple filters with commas (for example, status:0,tags:sensor).

Sorts endpoints by field value. Use `<operator><field>` format. Combine multiple sort fields with commas (for example, `-status,id`). **Operators:** - `-` descending (Z-A for text, highest number first) - `+` ascending (A-Z for text, lowest number first) Defaults to ascending order if no operator is specified. Defaults to `id` if no sort field is specified. Endpoints with identical values are sorted by ascending `id`.

pageintegerOptional>=1Defaults to 1

Page number to retrieve. Starts at 1.

per_pageintegerOptional1-1000Defaults to 1000

Number of endpoints to return per page.

Response headers

Linkstring

Links to navigate between pages (first, previous, next, last).

X-Count-Per-Pageinteger

Number of endpoints per page.

X-Current-Pageinteger

Current page number.

X-Total-Countinteger

Total number of endpoints matching the query.

X-Total-Pagesinteger

Total number of pages.

X-Filterstring

Applied filter criteria from the q parameter.

X-Sortstring

Applied sort field from the sort parameter.

Response

Returns an array of endpoint objects. Pagination metadata is included in the response headers.

statusobject

Endpoint connectivity status. Values are 0 (Enabled), 1 (Disabled), or 2 (Deleted).

tariff_profileobject

Tariff profile that determines pricing and data limits for this endpoint.

service_profileobject

Service profile that determines network access settings for this endpoint.

idinteger

Unique identifier for the endpoint.

createdstringformat: "date-time"

Date and time when the endpoint was created (ISO 8601 format).

last_updatedstringformat: "date-time"

Date and time when the endpoint was last modified (ISO 8601 format).

namestring

Display name for the endpoint.

tagsstring or null

Comma-separated list of tags. Use tag_assignments for structured tag data.

ip_addressstring

Private IP address assigned to this endpoint within the IP address space.

imeistring or null

International Mobile Equipment Identity with Software Version Number (IMEISV) (16 digits).

imei_lockboolean

If true, this endpoint only allows connections from the device with the specified IMEI.

tag_assignmentslist of objects

Structured tag data with color information. Alternative to the comma-separated tags field.

simobject or null

SIM card assigned to this endpoint. null if no SIM is assigned.

ip_address_spaceobject

IP address space that contains this endpoint's private IP address.

imei_with_luhnstring or null

International Mobile Equipment Identity with Luhn check digit, without Software Version Number (SVN) (15 digits).

runtime_dataobject

Real-time network attachment data. Only present when the endpoint is connected.

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

1	[
2	{
3	"status": {
4	"id": 0,
5	"description": "Enabled"
6	},
7	"tariff_profile": {
8	"id": 100,
9	"name": "Global IoT Plan"
10	},
11	"service_profile": {
12	"id": 200,
13	"name": "Standard IoT"
14	},
15	"id": 1,
16	"created": "2024-01-15T10:30:00.000+0000",
17	"last_updated": "2024-06-20T14:45:00.000+0000",
18	"name": "Weather Station 01",
19	"tags": "sensor,outdoor,weather",
20	"ip_address": "10.0.0.1",
21	"imei": "3561234567890123",
22	"imei_lock": true,
23	"tag_assignments": [
24	{
25	"id": 1,
26	"name": "sensor",
27	"tag_color": {
28	"id": 3
29	}
30	},
31	{
32	"id": 2,
33	"name": "outdoor",
34	"tag_color": {
35	"id": 5
36	}
37	},
38	{
39	"id": 3,
40	"name": "weather",
41	"tag_color": {
42	"id": 7
43	}
44	}
45	],
46	"sim": {
47	"id": 500,
48	"iccid": "8988303000001234567",
49	"iccid_with_luhn": "89883030000012345671",
50	"status": {
51	"id": 1,
52	"description": "Activated"
53	},
54	"imsi": "901430001234567",
55	"msisdn": "882850001234567",
56	"sim_profile_type": {
57	"id": 1
58	}
59	},
60	"ip_address_space": {
61	"id": 1
62	},
63	"imei_with_luhn": "356123456789012"
64	}
65	]