Query parameters

• Eid string

  List the eSIM Profiles that have been associated with an EId.

• SimSid string

  Find the eSIM Profile resource related to a Sim resource by providing the SIM SID. Will always return an array with either 1 or 0 records.

• Status string

  List the eSIM Profiles that are in a given status.

  Values are new, reserving, available, downloaded, installed, or failed.

• 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

  • esim_profiles array[object]
    Hide esim_profiles attributes Show esim_profiles attributes array[object]

    • account_sid string | null

      The SID of the Account to which the eSIM Profile resource belongs

      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

    • eid string | null

      Identifier of the eUICC that can claim the eSIM Profile

    • error_code string | null

      Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state

    • error_message string | null

      Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state

    • iccid string | null

      The ICCID associated with the Sim resource

    • sid string | null

      The unique string that identifies the resource

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

    • sim_sid string | null

      The SID of the Sim resource that this eSIM Profile controls

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

    • smdp_plus_address string(uri) | null

      Address of the SM-DP+ server from which the Profile will be downloaded

    • status string | null

      The status of the eSIM Profile

      Values are new, reserving, available, downloaded, installed, or failed.

    • url string(uri) | null

      The absolute URL of the eSIM Profile resource

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)