SIM Configuration

List SIM configurations

Returns available sim configurations based on the plans visible to all of a user's orgs. Optionally filter specific configurations with the parameters below.

get/simcards/configurations/

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/simcards/configurations/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

idsstring

Comma-separated configuration IDs to filter by

carrier_idsstring

Comma-separated carrier IDs to filter by

disabled_carrier_idsstring

Comma-separated disabled carrier IDs to filter by

enabled_carrier_idinteger

Filter by enabled carrier ID

fallback_carrier_idinteger

Filter by fallback carrier ID

namestring

Filter by configuration name (case-insensitive substring match)

plan_idsstring

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

orgidinteger

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

limitinteger

Maximum number of results (max 5000, default 50)

startafterinteger

Return results after this configuration ID

Response

successboolean

Indicates whether the request was successful.

limitinteger

sizeinteger

continuesboolean

lastidinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.