Skip to main content
API docs by Redocly

1GLOBAL Enterprise APIs (1.0)

Download OpenAPI specification:Download

1GLOBAL Enterprise APIs

Accounts

The Accounts API provides organizations with a complete view of their active business accounts (individual accounts representing specific organizational units, departments), offering information to enhance compliance monitoring and centralized management.

Use cases:

  • Compliance Oversight: Consolidates account details for streamlined compliance and regulatory monitoring.
  • Centralized Account Visibility: Enables administrators to access all organizational accounts, simplifying management with quick visibility into key details such as account name, status, and associated countries.

Prerequisites:

  • Obtain a relevant license for the API.

List Accounts

Get a list of all accounts associated with the organization.

Authorizations:
JWT
query Parameters
limit
integer <int32> (Limit) [ 1 .. 100 ]
Default: 10

Specifies the maximum number of results to return in the response.

cursor
string (Cursor) [ 1 .. 128 ] characters

Marker used for pagination to retrieve the next set of results in a list.

Responses

Response samples

Content type
application/json
{}

Get Account

Returns information for a specific business account.

Authorizations:
JWT
path Parameters
id
string
Example: acc_01HTJA47C93ABKKR58T05JBAJB

Unique identifier for the business account.

Responses

Response samples

Content type
application/json
{}

Subscribers

The Subscriber API allows organizations to retrieve a detailed list of their subscribers (individual users associated with the organization’s accounts e.g. employees).

Use cases:

  • Compliance and Security Oversight: Supports compliance requirements by giving visibility into individual subscriber data, allowing quick verification of subscriber name, group, and identification details.
  • Contact and Group Information Access: Allows administrators to view key subscriber details, including names, email addresses, employee IDs, and group affiliations, helping ensure data accuracy and alignment across the organization.

Pre-requisites:

  • Obtain a relevant license for the API.

List Subscribers

Authorizations:
JWT
query Parameters
limit
integer <int32> (Limit) [ 1 .. 100 ]
Default: 10

Specifies the maximum number of results to return in the response.

cursor
string (Cursor) [ 1 .. 128 ] characters

Marker used for pagination to retrieve the next set of results in a list.

Responses

Response samples

Content type
application/json
{}

Get Subscriber

Authorizations:
JWT
path Parameters
id
string
Example: sbr_01HTQ8Z5HR26EN2HE797W5SZP9

A unique identifier for the subscriber, formatted as a 26-character alphanumeric string prefixed with "sbr_"

Responses

Response samples

Content type
application/json
{}

Subscriptions

Endpoints for managing your subscriptions

List Subscriptions

Authorizations:
JWT
query Parameters
status
string
Enum: "active" "terminated"

The status of the subscription

limit
integer <int32> (Limit) [ 1 .. 100 ]
Default: 10

Specifies the maximum number of results to return in the response.

cursor
string (Cursor) [ 1 .. 128 ] characters

Marker used for pagination to retrieve the next set of results in a list.

header Parameters
Prefer
string
Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

Content type
application/json
{}

Get Subscription

Authorizations:
JWT
path Parameters
id
string
Example: sub_01HTJA47C93ABKKR58T05JBAJB

The ID of the subscription

header Parameters
Prefer
string
Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

Content type
application/json
{}

Get Subscription's Phone Numbers

Authorizations:
JWT
path Parameters
id
string
Example: sub_01HTJA47C93ABKKR58T05JBAJB

The ID of the subscription

Responses

Response samples

Content type
application/hal+json
{}

Messages

The Messages API allows organizations to send SMS messages directly from authorized subscription numbers to one or more recipients.

Use cases:

  • Alert messages: for critical situations requiring immediate action such as emergency alerts or safety notifications.
  • Updates and Notifications: keep customers informed with reminders, updates, and notifications.
  • Marketing messages: send targeted promotional SMS messages to drive engagement,sales and customer interest.
  • Customer service: enable proactive engagement improving customer experience.

Notes:

  • This API incurs separate billing, and the charges for messages sent are consumed by the SMS plan associated with the authorized subscription number.
  • This is a Premium API, and is licensed separately.

Prerequisites:

  • Obtain a relevant license for the API.
  • Provide 1GLOBAL with a list of allowed subscription numbers authorized to send SMS messages through the API.

Send SMS

Sends SMS messages from authorized subscription numbers to specified recipients.

Authorizations:
JWT
Request Body schema: application/json
from
string^(\+\d{1,15}|\d{1,15})$

Authorized subscription number sending the message, in E.164 format

to
Array of strings (Msisdn) <= 1000 items [^(\+\d{1,15}|\d{1,15})$]

Array of up to 1,000 recipient phone numbers in E.164 format

text
string <= 500 characters

The content of the SMS message, limited to 500 characters.

Responses

Request samples

Content type
application/json
{
  • "from": "+11114567890",
  • "to": [
    ],
  • "text": "Thank you for using our service"
}

Response samples

Content type
application/json
{
  • "sms_id": "sms_01JBCG33BC2PS4J76JN685GN56"
}

Orders

The Orders API enables organizations to create new subscriptions by providing the details to 1GLOBAL. By integrating the Orders API, the organizations can significantly streamline their subscription management process and improve operational efficiency.

Use cases

  • Provisioning new eSIM Subscriptions: Easily handles eSIM provisioning, making it suitable for enterprises of all sizes.
  • SIM Subscription Upgrades or Plan Changes: Making it quicker for customers to upgrade their plans without the need for physical SIM swaps.

Prerequisites:

  • Obtain a relevant license for the API.

Create Order

Create a new order for a subscriber or change the subcription from physical SIM to eSIM.

Authorizations:
JWT
Request Body schema: application/json
required
type
required
string

The type of order requested.

account_id
required
string^acc_[0-9A-Z]{26}$

Unique account identifier to provision new subscription.

template_id
string^otpl_[0-9A-Z]{26}$

The ID of the pre-configured template including plans and phone numbers. Templates are customized for each customer and must be obtained from the Account Manager.

required
object

Subscriber's information using new subscription.

required
object

Configuration of the SIM profile to be provisioned.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "activate_subscription",
  • "account_id": "string",
  • "template_id": "string",
  • "subscriber": {
    },
  • "sim_profile": {
    }
}

Response samples

Content type
application/json
{}

Get Order

Retrieve the current status of a previously submitted order.

Authorizations:
JWT
path Parameters
id
string^order_[0-9A-Z]{26}$
Example: order_01HZQ8GENA2K171RTJ3Z5FWW9R

The ID of the order for which the status is to be retrieved.

Responses

Response samples

Content type
application/json
{}