A SIM is a unique card that identifies itself to a specific mobile network and provides voice, text, and data connectivity to a user’s device. There are two types of available SIMs: eSIM and pSIM. eSIMs can be activated and installed instantly on any eSIM compatible device, pSIMs (physical SIMs) must be provided to the user or installed into the device beforehand.
Type of object is always sim.
sim Unique identifier for the SIM.
"sim_0SNlurA049MEWV1BAAmWZULA4lf6"Time when the SIM was created.
"2021-01-21T19:38:34Z"The ICCID (integrated circuit card identifier) associated with the SIM.
"89883070000007537119"The ID of the network provider of the SIM.
"p9"The status of the SIM. Can be active or inactive.
inactive active retired null when the SIM is not suspended.nullThe status of the suspension. It can have one of the following values:
suspending: The suspension was requested and the network provider has not confirmed it yet.suspended: The network provider confirmed the suspension.unsuspending: A request to unsuspend the SIM was made and the network provider has not confirmed it yet. The SIM still has no service."suspended"suspended suspending unsuspending Time of the last transition of the suspension.
"2026-09-24T10:00:00Z"The type of the SIM. Can be eSIM or pSIM.
eSIM pSIM {
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34.0Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": null,
"type": "eSIM"
}
Retrieves the details of an existing eSIM profile for a given SIM.
A 404 response will be returned if the SIM does not exist, or is a pSIM.
Note that for providers other than p3, p14 or p15 the status of
the profile will currently always be unknown.
Related guide: eSIM profile lifecycle
Returns the eSimProfile if it exists.
Type of object is always eSimProfile.
eSimProfile The current status of the eSimProfile.
Supported providers are p3, p11, p12, p14, p15, p18 and p32.
This will be unknown when:
Related guide: eSIM profile lifecycle
deleted disabled downloaded enabled installed unknown Time at which the status was last updated.
"2024-03-13T15:36:01Z"curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/{sim}/eSimProfile \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"
{
"object": "eSimProfile",
"sim": {
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": null,
"type": "eSIM"
},
"status": "deleted",
"updatedAt": "2024-03-13T15:36:01Z"
}
Returns a list of SIMs. The SIMs returned are sorted by creation date, with the most recently created SIMs appearing first.
The network provider ID for the sim to be filtered by.
A comma-separated list of statuses to filter the sims by.
inactive,activeThe type for the sim to be filtered by.
eSIM pSIM The unique identifier for the user to be filtered by.
"usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"A cursor for use in pagination. The after parameter takes an object ID that defines the position in the list, only items immediately following the item with that ID will be returned.
A cursor for use in pagination. The before parameter takes an object ID that defines the position in the list, only items immediately preceding the item with that ID will be returned.
The limit of items to be returned in the list, between 0 and 200.
2010>= 0<= 200Returns a dictionary with an items property that contains an array of SIMs.
Type of object is always list.
list sim.A unique identifier to be used as after pagination parameter if more items are available sorted after the current batch of items.
A unique identifier to be used as before pagination parameter if more items are available sorted before the current batch of items.
curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"
{
"object": "list",
"items": [
{
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": null,
"type": "eSIM"
}
],
"moreItemsAfter": null,
"moreItemsBefore": null
}
Retrieve the details of an existing SIM which the authenticated user is authorized to view.
Returns the SIM if it exists.
Type of object is always sim.
sim Unique identifier for the SIM.
"sim_0SNlurA049MEWV1BAAmWZULA4lf6"Time when the SIM was created.
"2021-01-21T19:38:34Z"The ICCID (integrated circuit card identifier) associated with the SIM.
"89883070000007537119"The ID of the network provider of the SIM.
"p9"The status of the SIM. Can be active or inactive.
inactive active retired null when the SIM is not suspended.nullThe status of the suspension. It can have one of the following values:
suspending: The suspension was requested and the network provider has not confirmed it yet.suspended: The network provider confirmed the suspension.unsuspending: A request to unsuspend the SIM was made and the network provider has not confirmed it yet. The SIM still has no service."suspended"suspended suspending unsuspending Time of the last transition of the suspension.
"2026-09-24T10:00:00Z"The type of the SIM. Can be eSIM or pSIM.
eSIM pSIM curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/{sim} \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"
{
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": null,
"type": "eSIM"
}
Update the details of an existing SIM.
Returns the updates SIM.
Type of object is always sim.
sim Unique identifier for the SIM.
"sim_0SNlurA049MEWV1BAAmWZULA4lf6"Time when the SIM was created.
"2021-01-21T19:38:34Z"The ICCID (integrated circuit card identifier) associated with the SIM.
"89883070000007537119"The ID of the network provider of the SIM.
"p9"The status of the SIM. Can be active or inactive.
inactive active retired null when the SIM is not suspended.nullThe status of the suspension. It can have one of the following values:
suspending: The suspension was requested and the network provider has not confirmed it yet.suspended: The network provider confirmed the suspension.unsuspending: A request to unsuspend the SIM was made and the network provider has not confirmed it yet. The SIM still has no service."suspended"suspended suspending unsuspending Time of the last transition of the suspension.
"2026-09-24T10:00:00Z"The type of the SIM. Can be eSIM or pSIM.
eSIM pSIM curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/{sim} \
-X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json" \
-d '{
"metadata": {}
}'
{
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": null,
"type": "eSIM"
}
Retrieve the credentials of an existing SIM.
Returns the SIM credentials.
Type of object is always simCredentials.
simCredentials eSIM activation code to download and install the profile in a device. Only available for type eSIM.
"LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2"URL to install the eSIM profile on Android devices. Only available for type eSIM.
Be careful how you share this URL, it contains the credentials required to install the eSIM profile.
"https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2"URL to install the eSIM profile on iOS devices. Only available for type eSIM.
Be careful how you share this URL, it contains the credentials required to install the eSIM profile.
"https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2"The first PUK code for the SIM. Not available for all network providers.
"12345678"The second PUK code for the SIM. Not available for all network providers.
"12345678"URL of the activation code in QR-Code format. Only available for type eSIM.
Be careful how you share this URL, it can be accessed publicly without authentication.
"https://files.gigs.com/qrcode/example/pUNIvfeLBNQ.png"Unique identifier for the SIM this credentials are for.
"sim_0SNlurA049MEWV1BAAmWZULA4lf6"curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/{sim}/credentials \
-X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"
{
"object": "simCredentials",
"activationCode": "LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2",
"androidInstallUrl": "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2",
"iosInstallUrl": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2",
"puk1": "12345678",
"puk2": "12345678",
"qrCodeUrl": "https://files.gigs.com/qrcode/example/pUNIvfeLBNQ.png",
"sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
}
Searches for existing SIMs matching the given parameters.
Returns a list schema response with all found SIMs.
Type of object is always list.
list sim.A unique identifier to be used as after pagination parameter if more items are available sorted after the current batch of items.
A unique identifier to be used as before pagination parameter if more items are available sorted before the current batch of items.
curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/search \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json" \
-d '{
"iccid": "89883070000007537119",
"type": [
"eSIM"
]
}'
{
"object": "list",
"items": [
{
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": null,
"type": "eSIM"
}
],
"moreItemsAfter": null,
"moreItemsBefore": null
}
Suspends all connectivity of the SIM, blocking voice, SMS and data, for example when the device is lost or stolen. The subscription, the phone number and billing are not affected.
If the SIM is still suspended 30 days after the suspension took effect, its subscription ends. Unsuspending the SIM before then cancels the end.
The SIM is returned with a suspending suspension, which becomes suspended once the network provider confirms it.
This endpoint is currently in preview and might change in the future.
We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.
Returns the SIM with the requested suspension.
Type of object is always sim.
sim Unique identifier for the SIM.
"sim_0SNlurA049MEWV1BAAmWZULA4lf6"Time when the SIM was created.
"2021-01-21T19:38:34Z"The ICCID (integrated circuit card identifier) associated with the SIM.
"89883070000007537119"The ID of the network provider of the SIM.
"p9"The status of the SIM. Can be active or inactive.
inactive active retired null when the SIM is not suspended.nullThe status of the suspension. It can have one of the following values:
suspending: The suspension was requested and the network provider has not confirmed it yet.suspended: The network provider confirmed the suspension.unsuspending: A request to unsuspend the SIM was made and the network provider has not confirmed it yet. The SIM still has no service."suspended"suspended suspending unsuspending Time of the last transition of the suspension.
"2026-09-24T10:00:00Z"The type of the SIM. Can be eSIM or pSIM.
eSIM pSIM curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/{sim}/suspend \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"
{
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": {
"status": "suspending",
"updatedAt": "2026-09-24T10:00:00Z"
},
"type": "eSIM"
}
Restores the connectivity of a suspended SIM, for example once a lost device is recovered.
The SIM is returned with an unsuspending suspension and keeps no service until the provider confirms, at which point the suspension is cleared.
This endpoint is currently in preview and might change in the future.
We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.
Returns the SIM, which stays suspended until the network provider confirms it can proceed to unsuspend.
Type of object is always sim.
sim Unique identifier for the SIM.
"sim_0SNlurA049MEWV1BAAmWZULA4lf6"Time when the SIM was created.
"2021-01-21T19:38:34Z"The ICCID (integrated circuit card identifier) associated with the SIM.
"89883070000007537119"The ID of the network provider of the SIM.
"p9"The status of the SIM. Can be active or inactive.
inactive active retired null when the SIM is not suspended.nullThe status of the suspension. It can have one of the following values:
suspending: The suspension was requested and the network provider has not confirmed it yet.suspended: The network provider confirmed the suspension.unsuspending: A request to unsuspend the SIM was made and the network provider has not confirmed it yet. The SIM still has no service."suspended"suspended suspending unsuspending Time of the last transition of the suspension.
"2026-09-24T10:00:00Z"The type of the SIM. Can be eSIM or pSIM.
eSIM pSIM curl https://api.gigs.com/projects/${GIGS_PROJECT}/sims/{sim}/unsuspend \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json"
{
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"metadata": {},
"createdAt": "2021-01-21T19:38:34Z",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"suspension": {
"status": "unsuspending",
"updatedAt": "2026-09-24T10:00:00Z"
},
"type": "eSIM"
}