Documentation

API endpoint:

get

/v1/packages

Description:

Use this endpoint to retrieve a filtered list of Products in your account.

Request example:

curl --location --request GET 'https://api.simvox.com/v1/packages' \
--header 'Authorization: Bearer {token}'


Parameter	Type	Description
country	Optional string	ISO2 code for a country, e.g. fr, us, ca
pageNum	Optional integer	Current page number for pagination
pageSize	Optional integer	Number of items per page
data	Optional integer	Filter by data amount in MB (e.g., 1000 for 1GB, 2000 for 2GB)
validity	Optional integer	Filter by validity period (e.g., 7, 30)
title	Optional string	Filter by package title or keyword
unlimited	Optional boolean	Filter by unlimited packages (e.g., 1 for unlimited, 0 for limited)

API endpoint:

get

/v1/packages/{package_id}

Description:

Use this endpoint to get the details of a single Product (Data Plan type)

Request example:

curl --location --request GET 'https://api.simvox.com/v1/packages/{package_id}' \
--header 'Authorization: Bearer {token}'


Parameter	Type	Description
package_id	Required string	The Data Plan ID is linked to a specific mobile data plan, which could include voice, text, and data services

API endpoint:

get

/v1/package-attributes

Description:

Retrieves available attributes of All eSIM packages based on the selected country.

Request example:

curl --location --request GET 'https://api.simvox.com/v1/package-attributes' \
--header 'Authorization: Bearer {token} \


Parameter	Type	Description
country	Optional string	ISO2 code for a country, e.g. fr, us, ca