1GLOBAL Enterprise APIs (1.0)

Download OpenAPI specification:Download

1GLOBAL Enterprise APIs

Subscriptions

Early Access
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
cursor	string (Cursor) [ 1 .. 128 ] characters

header Parameters

Prefer

string

Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

200
401

Content type

application/json

{"_embedded": {"subscriptions": [{"id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
"status": "active",
"created_at": "2023-01-01T00:00:00:000Z",
"terminated_at": null,
"_embedded": {"account": {"id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
"reference_code": "123456789",
"name": "string",
"country": "string",
"_links": {"self": {"href": "https://api.1global.com/enterprise/accounts/acc_01HTQ8VBN4DEJP5S8BPV4657VG"
}
}
},
"subscriber": {"id": "per_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string",
"_links": {"self": {"href": "https://api.1global.com/enterprise/persons/per_01HTJA47C93ABKKR58T05JBAJB"
}
}
},
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
},
"services": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}
}
}
]
}
}

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

200
401
404

Content type

application/json

{"id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
"status": "active",
"created_at": "2023-01-01T00:00:00:000Z",
"terminated_at": null,
"_embedded": {"account": {"id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
"reference_code": "123456789",
"name": "string",
"country": "string",
"_links": {"self": {"href": "https://api.1global.com/enterprise/accounts/acc_01HTQ8VBN4DEJP5S8BPV4657VG"
}
}
},
"subscriber": {"id": "per_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string",
"_links": {"self": {"href": "https://api.1global.com/enterprise/persons/per_01HTJA47C93ABKKR58T05JBAJB"
}
}
},
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
},
"services": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}
}
}

Get Subscription's Phone Numbers

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
}

Get Subscription's Services

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}

Get Subscription's Sim Profile

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
}

Orders

Preview
Endpoints for changing your service

Create Order

Submit a request to perform changes on the Subscription list under a given Account

Authorizations:

JWT

Request Body schema: application/json
required

type required	string The Order's requested action - create a new Subscription activate_subscription
account_id required	string^acc_[0-9A-Z]{26}$ The account where the new subscription will be provisioned
template_id	string^otpl_[0-9A-Z]{26}$ The ID of the pre-configured template which includes plans and phone numbers
required	object The Person who will use the new Subscription
required	object Configuration of the SIM Profile to be provisioned

Responses

Request samples

Payload

Content type

application/json

Example

activate_subscription

{"type": "activate_subscription",
"account_id": "string",
"template_id": "string",
"subscriber": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"employee_id": "string",
"group": "string"
},
"sim_profile": {"sim_type": "esim",
"delivery": {"type": "email",
"to": ["user@example.com"
],
"cc": ["user@example.com"
]
}
}
}

Response samples

201
400
401
429

Content type

application/json

{"id": "string",
"status": "pending",
"type": "activate_subscription",
"account_id": "string",
"subscription_id": "string",
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"delivery": {"type": "email",
"to": ["user@example.com"
],
"cc": ["user@example.com"
]
},
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
],
"subscriber": {"id": "per_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string",
"_links": {"self": {"href": "https://api.1global.com/enterprise/persons/per_01HTJA47C93ABKKR58T05JBAJB"
}
}
}
}

Get Order

Consult the status and/or result of a previously submitted order

Authorizations:

JWT

path Parameters

id	string^order_[0-9A-Z]{26}$ Example: order_01HZQ8GENA2K171RTJ3Z5FWW9R The ID of the order

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"status": "pending",
"type": "activate_subscription",
"account_id": "string",
"subscription_id": "string",
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"delivery": {"type": "email",
"to": ["user@example.com"
],
"cc": ["user@example.com"
]
},
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
],
"subscriber": {"id": "per_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string",
"_links": {"self": {"href": "https://api.1global.com/enterprise/persons/per_01HTJA47C93ABKKR58T05JBAJB"
}
}
}
}

1GLOBAL Enterprise APIs (1.0)

Subscriptions

List Subscriptions

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Get Subscription

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get Subscription's Phone Numbers

Authorizations:

path Parameters

Responses

Response samples

Get Subscription's Services

Authorizations:

path Parameters

Responses

Response samples

Get Subscription's Sim Profile

Authorizations:

path Parameters

Responses

Response samples

Orders

Create Order

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Order

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required