Retrieve a list of Super SIMs from your account

GET /v1/Sims

Individual IoT Super SIMs

Retrieve a list of Super SIMs from your account.

Query parameters

  • Status string

    The status of the Sim resources to read. Can be new, ready, active, inactive, or scheduled.

    Values are new, ready, active, inactive, or scheduled.

  • Fleet string

    The SID or unique name of the Fleet to which a list of Sims are assigned.

  • Iccid string

    The ICCID associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • sims array[object]
      Hide sims attributes Show sims attributes
      • account_sid string | null

        The SID of the Account that the Super SIM belongs to

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • date_created string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was last updated

      • fleet_sid string | null

        The unique ID of the Fleet configured for this SIM

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HF[0-9a-fA-F]{32}$.

      • iccid string | null

        The ICCID associated with the SIM

      • links object(uri-map) | null
      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HS[0-9a-fA-F]{32}$.

      • status string | null

        The status of the Super SIM

        Values are new, ready, active, inactive, or scheduled.

      • unique_name string | null

        An application-defined string that uniquely identifies the resource

      • url string(uri) | null

        The absolute URL of the Sim Resource
GET /v1/Sims 
curl \
 -X GET https://supersim.twilio.com/v1/Sims \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "sims": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "fleet_sid": "string",
      "iccid": "string",
      "links": {},
      "sid": "string",
      "status": "new",
      "unique_name": "string",
      "url": "https://example.com"
    }
  ]
}