Retrieve a list of Fleets from your account

GET /v1/Fleets

Configure shared settings inherited by all Super SIMs assigned to the Fleet

Retrieve a list of Fleets from your account.

Query parameters

  • NetworkAccessProfile string

    The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.

  • 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
    • fleets array[object]
      Hide fleets attributes Show fleets attributes
      • account_sid string | null

        The SID of the Account that created the resource

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

      • data_enabled boolean | null

        Defines whether SIMs in the Fleet are capable of using data connectivity

      • data_limit integer | null

        The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume

      • data_metering string | null

        The model by which a SIM is metered and billed

        Value is payg.

      • 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

      • ip_commands_method string(http-method) | null

        A string representing the HTTP method to use when making a request to ip_commands_url

        Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

      • ip_commands_url string(uri) | null

        The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device

      • network_access_profile_sid string | null

        The SID of the Network Access Profile of the Fleet

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

      • sid string | null

        The unique string that identifies the resource

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

      • sms_commands_enabled boolean | null

        Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands

      • sms_commands_method string(http-method) | null

        A string representing the HTTP method to use when making a request to sms_commands_url

        Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

      • sms_commands_url string(uri) | null

        The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number

      • unique_name string | null

        An application-defined string that uniquely identifies the resource

      • url string(uri) | null

        The absolute URL of the Fleet resource

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Fleets 
curl \
 -X GET https://supersim.twilio.com/v1/Fleets \
 --user "username:password"
Response examples (200) 
{
  "fleets": [
    {
      "account_sid": "string",
      "data_enabled": true,
      "data_limit": 42,
      "data_metering": "payg",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "ip_commands_method": "HEAD",
      "ip_commands_url": "https://example.com",
      "network_access_profile_sid": "string",
      "sid": "string",
      "sms_commands_enabled": true,
      "sms_commands_method": "HEAD",
      "sms_commands_url": "https://example.com",
      "unique_name": "string",
      "url": "https://example.com"
    }
  ],
  "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"
  }
}