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(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

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

    • sid string | null

      The unique string that we created to identify the eSIM Profile resource.

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

    • 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}$.

    • iccid string | null

      The ICCID associated with the Sim resource.

    • 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}$.

    • status string

      The status of the eSIM Profile. Can be: new, reserving, available, downloaded, installed or failed. See the eSIM Profile Status Values for a description of each.

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

    • eid string | null

      Identifier of the eUICC that can claim the eSIM Profile.

    • smdp_plus_address string(uri) | null

      Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status available.

    • matching_id string | null

      Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if generate_matching_id is set to true when creating the eSIM profile reservation.

    • activation_code string | null

      Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an 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.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • 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) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)