Skip to navigation
Service ProfilesRetrieve a service profile

Retrieve a service profile

Required permissions Beta Learn more

ServiceProfile + Get

Roles: Administrator User Observer

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_3genumOptional

1 means enabled, 0 means disabled.

Allowed values:
allowed_4genumOptional

1 means enabled, 0 means disabled.

Allowed values:
allowed_nb_iotenumOptional

1 means enabled, 0 means disabled.

Allowed values:
allowed_nb_iot_geoenumOptional

1 means enabled, 0 means disabled.

Allowed values:
apply_sms_quotaenumOptional

1 means enabled, 0 means disabled.

Allowed values:
apply_data_quotaenumOptional

1 means enabled, 0 means disabled.

Allowed values:
retailenumOptional

1 means enabled, 0 means disabled.

Allowed values:
sms_p2p_intenumOptional

1 means enabled, 0 means disabled.

Allowed values:
sms_p2p_extenumOptional

1 means enabled, 0 means disabled.

Allowed values:
prepaidenumOptional

1 means enabled, 0 means disabled.

Allowed values:
nipdpenumOptional

"1" means enabled, "0" means disabled.

Allowed values:
used_countstringOptional
api_callbackobjectOptional
api_secretobjectOptional
moc_callbackobjectOptional
esme_interface_typeobjectOptional
breakout_regionobjectOptional
servicelist of objectsOptional
ip_firewall_rule_setobjectOptional
dns_firewall_rule_setobjectOptional
d2dobjectOptional

Device-to-device (D2D) mode of the service profile. Device-to-device is opt-in and enabled per organization. To request access, contact your account manager.

Errors

403
Forbidden Error