Documentation

List Configurations

List all telephony configurations in your organization

List all telephony configurations in your organization

Quick reference#

List all telephony configurations in your organization. Send the request to GET /api/v1/organizations/telephony-configs on the Paladin API base URL.

Method	`GET`
Path	`/api/v1/organizations/telephony-configs`
Path parameters	None in the path.
Authentication	Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side.

Before you call#

Confirm you are using the production base URL shown in the API reference.
Make sure any path IDs belong to the same Paladin organization as the credential you are using.
Validate request bodies and required fields before sending production traffic.

Common error checks#

Use 401 or 403 responses to check credentials, organization scope, and permissions.
Use 404 responses to check whether the referenced resource exists in the current organization.
Use 422 responses to inspect missing or invalid request fields.

OpenAPI#

GET /api/v1/organizations/telephony-configs

openapi: 3.1.0
info:
  title: Paladin API
  description: API for the Paladin app
  version: 1.0.0
servers:
  - url: https://app.paladin.northmanngrp.com
    description: Production

security: []
paths:
  /api/v1/organizations/telephony-configs:
    get:
      tags:
        - main
        - organizations
      summary: List Telephony Configurations
      description: List the org's telephony configurations with phone-number counts.
      operationId: list_telephony_configurations_api_v1_organizations_telephony_configs_get
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelephonyConfigurationListResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TelephonyConfigurationListResponse:
      properties:
        configurations:
          items:
            $ref: '#/components/schemas/TelephonyConfigurationListItem'
          type: array
          title: Configurations
      type: object
      required:
        - configurations
      title: TelephonyConfigurationListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TelephonyConfigurationListItem:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        provider:
          type: string
          title: Provider
        is_default_outbound:
          type: boolean
          title: Is Default Outbound
        phone_number_count:
          type: integer
          title: Phone Number Count
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - name
        - provider
        - is_default_outbound
        - created_at
        - updated_at
      title: TelephonyConfigurationListItem
      description: One row in ``GET /telephony-configs``.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError