Skip to main content
GET
/
simcards
/
configurations
/
List SIM configurations
curl --request GET \
  --url https://dashboard.hologram.io/api/1/simcards/configurations/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "lastid": 123,
  "links": {
    "path": "<string>",
    "base": "<string>",
    "next": "<string>"
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "enabled_carrier_id": 123,
      "fallback_carrier_id": 123,
      "disabled_carrier_ids": [
        123
      ],
      "vzw_sku": "<string>",
      "applicable_plan_ids": [
        123
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

​
ids
string

Comma-separated configuration IDs to filter by

​
carrier_ids
string

Comma-separated carrier IDs to filter by

​
disabled_carrier_ids
string

Comma-separated disabled carrier IDs to filter by

​
enabled_carrier_id
integer

Filter by enabled carrier ID

​
fallback_carrier_id
integer

Filter by fallback carrier ID

​
name
string

Filter by configuration name (case-insensitive substring match)

​
plan_ids
string

Comma-separated plan IDs; when provided, applicable_plan_ids is included in each result

​
orgid
integer

Organization ID; when provided, applicable_plan_ids is included in each result

​
limit
integer

Maximum number of results (max 5000, default 50)

​
startafter
integer

Return results after this configuration ID

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true

​
limit
integer
​
size
integer
​
continues
boolean
​
lastid
integer
​
links
object
​
data
object[]