Skip to main content

Get all SIM cards


Get all SIM cards belonging to the user that match the given filters.


Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

    include_sim_card_group boolean

    It includes the associated SIM card group object in the response when present.

    filter[sim_card_group_id] uuid

    A valid SIM card group ID.

    filter[tags] string[]

    A list of SIM card tags to filter on.

    If the SIM card contains all of the given tags they will be found.

    For example, if the SIM cards have the following tags:

    • ['customers', 'staff', 'test']
    • ['test']
    • ['customers']
    Searching for
    ['customers', 'test']
    returns only the first because it's the only one with both tags.
    Searching for
    returns the first two SIMs, because both of them have such tag.
    Searching for
    returns the first and last SIMs.
    filter[iccid] string

    A search string to partially match for the SIM card's ICCID.

    filter[status] string[]

    Possible values: [enabled, disabled, standby, data_limit_exceeded, unauthorized_imei]

    Filter by a SIM card's status.

    sort string

    Possible values: [current_billing_period_consumed_data.amount]

    Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign.

    Example: -current_billing_period_consumed_data.amount


200: Successful response

default: Unexpected error