Skip to main content

List LOA configurations

GET 
/porting/loa_configurations

List the LOA configurations.

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

Responses​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies the LOA configuration.

    company_name string

    The name of the company

    organization_id string

    The organization that owns the LOA configuration

    name string

    The name of the LOA configuration

    logo

    object

    The logo to be used in the LOA.

    document_id uuid

    Identifies the document that contains the logo.

    content_type string

    Possible values: [image/png]

    The content type of the logo.

    The logo to be used in the LOA.

    address

    object

    The address of the company.

    street_address string

    The street address of the company

    extended_address string

    The extended address of the company

    city string

    The locality of the company

    state string

    Possible values: Value must match regular expression ^[A-Z]{2}$

    The administrative area of the company

    zip_code string

    Possible values: Value must match regular expression ^[0-9]{5}(?:-[0-9]{4})?$

    The postal code of the company

    country_code string

    Possible values: Value must match regular expression ^[A-Z]{2}$

    The country code of the company

    The address of the company.

    contact

    object

    The contact information of the company.

    email email

    The email address of the contact

    phone_number string

    Possible values: Value must match regular expression ^\+\d{11,15}$

    The phone number of the contact

    The contact information of the company.

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

422: Unprocessable entity. Check message field in response for details.

500: Internal server error

Request samples

curl -L 'https://api.telnyx.com/v2/porting/loa_configurations' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "company_name": "Telnyx",
      "organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "name": "My LOA Configuration",
      "logo": {
        "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "content_type": "image/png"
      },
      "address": {
        "street_address": "311 W. Superior St",
        "extended_address": "Suite 504",
        "city": "Chicago",
        "state": "IL",
        "zip_code": "60654",
        "country_code": "US"
      },
      "contact": {
        "email": "[email protected]",
        "phone_number": "+12003270001"
      },
      "record_type": "porting_loa_configuration",
      "created_at": "2021-03-19T10:07:15.527000Z",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}