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.

    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

    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

    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

Loading...