Skip to main content

Get all SIM card groups

GET 

/sim_card_groups

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

Request

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.

    filter[name] uuid

    A valid SIM card group name.

    filter[private_wireless_gateway_id] uuid

    A Private Wireless Gateway ID associated with the group.

Responses

200: Successful response

Schema

    data

    object[]

  • Array [

  • id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    default boolean

    Indicates whether the SIM card group is the users default group.
    The default group is created for the user and can not be removed.

    name string

    A user friendly name for the SIM card group.

    data_limit

    object

    Upper limit on the amount of data the SIM cards, within the group, can use.

    amount decimal
    unit string

    consumed_data

    object

    Represents the amount of data consumed.

    unit string

    Default value: MB

    amount decimal
    sim_card_count integer

    The number of SIM cards associated with the group.

    private_wireless_gateway_id uuid

    The identification of the related Private Wireless Gateway resource.

    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...