> This page is for Server SDKs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# list

> List all Fabric resources.

List all Fabric resources across all resource types.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fabric/resources:
    get:
      operationId: subpackageResources_list_resources
      summary: List Resources
      description: >-
        Lists every supported Fabric resource in your SignalWire project,
        regardless of type. Use it for project-wide inventory or when you do not
        yet know whether an ID belongs to an AI Agent, script, SIP resource, or
        another resource type. Use a type-specific collection such as [SWML
        Scripts](/docs/apis/rest/swml-scripts/list-swml-scripts) or [SIP
        Credentials](/docs/apis/rest/sip-credentials/list-sip-credentials) to
        create resources or work with their full configuration.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or
        _Video_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_resources
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceListResponse'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
tags:
  - name: subpackage_resources
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    ResourceResponseAiType:
      type: string
      enum:
        - ai_agent
      description: The type of Resource
      title: ResourceResponseAiType
    AiAgentLanguagesItems:
      type: object
      properties: {}
      title: AiAgentLanguagesItems
    AiAgentParams:
      type: object
      properties: {}
      description: >-
        A JSON object containing parameters as key-value pairs.


        See [`ai.params` in the SWML
        reference](/docs/swml/reference/calling/ai#aiparams).
      title: AiAgentParams
    AiAgentPostPrompt:
      type: object
      properties: {}
      description: >-
        The final set of instructions and configuration settings to send to the
        agent.


        See [`ai.post_prompt` in the SWML
        reference](/docs/swml/reference/calling/ai#aipost_prompt).
      title: AiAgentPostPrompt
    AiAgentPronounceItems:
      type: object
      properties: {}
      title: AiAgentPronounceItems
    AiAgentPrompt:
      type: object
      properties: {}
      description: >-
        Defines the AI agent's personality, goals, behaviors, and instructions
        for handling conversations.

        The prompt establishes how the agent should interact with callers, what
        information it should gather,

        and how it should respond to various scenarios. It is recommended to
        write prompts using markdown formatting.


        See [`ai.prompt` in the SWML
        reference](/docs/swml/reference/calling/ai#aiprompt).
      title: AiAgentPrompt
    AiAgentSwaig:
      type: object
      properties: {}
      description: >-
        An object that configures the functions the agent can call during the
        dialogue: user-defined `functions`, shared `defaults`, `includes`,
        `native_functions`, `mcp_servers`, and `internal_fillers`.


        See [`ai.SWAIG` in the SWML
        reference](/docs/swml/reference/calling/ai#aiswaig).
      title: AiAgentSwaig
    AIAgent:
      type: object
      properties:
        hints:
          type: array
          items:
            type: string
          description: >-
            Words and phrases that help the agent understand what the caller
            says. Each string is passed to speech

            recognition as a hint, making that word or phrase more likely to be
            recognized.

            Hints don't change how the agent speaks; use `pronounce` for that.


            See [`ai.hints` in the SWML
            reference](/docs/swml/reference/calling/ai#aihints).
        languages:
          type: array
          items:
            $ref: '#/components/schemas/AiAgentLanguagesItems'
          description: >-
            An array of JSON objects defining supported languages in the
            conversation.

            Mutually exclusive with `multilingual`: if both are set,
            `multilingual` is used and

            this array is ignored.


            See [`ai.languages` in the SWML
            reference](/docs/swml/reference/calling/ai#ailanguages).
        params:
          $ref: '#/components/schemas/AiAgentParams'
          description: >-
            A JSON object containing parameters as key-value pairs.


            See [`ai.params` in the SWML
            reference](/docs/swml/reference/calling/ai#aiparams).
        post_prompt:
          $ref: '#/components/schemas/AiAgentPostPrompt'
          description: >-
            The final set of instructions and configuration settings to send to
            the agent.


            See [`ai.post_prompt` in the SWML
            reference](/docs/swml/reference/calling/ai#aipost_prompt).
        pronounce:
          type: array
          items:
            $ref: '#/components/schemas/AiAgentPronounceItems'
          description: >-
            An array of JSON objects to clarify the AI's pronunciation of words
            or expressions.


            See [`ai.pronounce` in the SWML
            reference](/docs/swml/reference/calling/ai#aipronounce).
        prompt:
          $ref: '#/components/schemas/AiAgentPrompt'
          description: >-
            Defines the AI agent's personality, goals, behaviors, and
            instructions for handling conversations.

            The prompt establishes how the agent should interact with callers,
            what information it should gather,

            and how it should respond to various scenarios. It is recommended to
            write prompts using markdown formatting.


            See [`ai.prompt` in the SWML
            reference](/docs/swml/reference/calling/ai#aiprompt).
        SWAIG:
          $ref: '#/components/schemas/AiAgentSwaig'
          description: >-
            An object that configures the functions the agent can call during
            the dialogue: user-defined `functions`, shared `defaults`,
            `includes`, `native_functions`, `mcp_servers`, and
            `internal_fillers`.


            See [`ai.SWAIG` in the SWML
            reference](/docs/swml/reference/calling/ai#aiswaig).
        agent_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of an AI Agent.
        name:
          type: string
          description: Name of the AI Agent.
      required:
        - prompt
        - agent_id
        - name
      description: >-
        Creates an AI agent that conducts voice conversations using automatic
        speech recognition (ASR),

        large language models (LLMs), and text-to-speech (TTS) synthesis.

        The agent processes caller speech in real-time, generates contextually
        appropriate responses,

        and can execute custom functions to interact with external systems
        through SignalWire AI Gateway (SWAIG).


        See the [SWML `ai` method reference](/docs/swml/reference/calling/ai)
        for the complete configuration contract.
      title: AIAgent
    ResourceResponseAI:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseAiType'
          description: The type of Resource
        ai_agent:
          $ref: '#/components/schemas/AIAgent'
          description: An object containing the response data of the AI Agent
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - ai_agent
      title: ResourceResponseAI
    ResourceResponseRemoteAiAgentType:
      type: string
      enum:
        - remote_ai_agent
      description: The type of Resource
      title: ResourceResponseRemoteAiAgentType
    RemoteAIAgent:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Remote AI Agent.
        name:
          type: string
          description: Name of the Remote AI Agent.
        primary_request_url:
          type: string
          format: uri
          description: >-
            URL of the agent you host. SignalWire requests the SWML document for
            each call from this URL.
        fallback_request_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            URL SignalWire requests the SWML document from if the primary URL
            cannot be reached or fails.
        status_callback_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            URL that receives a JSON event when a call to this agent completes,
            with details of the finished call.
      required:
        - id
        - name
        - primary_request_url
        - fallback_request_url
        - status_callback_url
      title: RemoteAIAgent
    ResourceResponseRemoteAIAgent:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseRemoteAiAgentType'
          description: The type of Resource
        remote_ai_agent:
          $ref: '#/components/schemas/RemoteAIAgent'
          description: An object containing the response data of the Remote AI Agent
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - remote_ai_agent
      title: ResourceResponseRemoteAIAgent
    ResourceResponseCallFlowType:
      type: string
      enum:
        - call_flow
      description: The type of Resource
      title: ResourceResponseCallFlowType
    CallFlowFlowData:
      type: object
      properties: {}
      description: >-
        Call Flow Builder state, stored as an opaque JSON object. Produced and
        consumed by the SignalWire Call Flow Builder UI; not used by SWML
        execution.
      title: CallFlowFlowData
    CallFlowRelayml:
      type: object
      properties: {}
      description: >-
        The calling SWML document this Call Flow executes. Uses [calling SWML
        methods](/docs/swml/reference/calling).
      title: CallFlowRelayml
    CallFlow:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a Call Flow.
        title:
          type: string
          description: The name of the Call Flow
        flow_data:
          $ref: '#/components/schemas/CallFlowFlowData'
          description: >-
            Call Flow Builder state, stored as an opaque JSON object. Produced
            and consumed by the SignalWire Call Flow Builder UI; not used by
            SWML execution.
        relayml:
          $ref: '#/components/schemas/CallFlowRelayml'
          description: >-
            The calling SWML document this Call Flow executes. Uses [calling
            SWML methods](/docs/swml/reference/calling).
        document_version:
          type: integer
          description: >-
            The current revision of the call flow. Every update must increase
            this number.
      required:
        - id
        - title
      title: CallFlow
    ResourceResponseCallFlow:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseCallFlowType'
          description: The type of Resource
        call_flow:
          $ref: '#/components/schemas/CallFlow'
          description: An object containing the response data of the Call Flow
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - call_flow
      title: ResourceResponseCallFlow
    ResourceResponseCxmlWebhookType:
      type: string
      enum:
        - cxml_webhook
      description: The type of Resource
      title: ResourceResponseCxmlWebhookType
    CXMLWebhookScriptType:
      type: string
      enum:
        - calling
        - messaging
        - faxing
      description: What a CXML Webhook handles.
      title: CXMLWebhookScriptType
    RequestUrlMethodType:
      type: string
      enum:
        - GET
        - POST
      description: The method type to use for the URL
      title: RequestUrlMethodType
    CXMLWebhook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the CXML Webhook.
        name:
          type: string
          description: Name of the CXML Webhook.
        script_type:
          $ref: '#/components/schemas/CXMLWebhookScriptType'
          description: Whether the CXML Webhook handles calls, messages, or faxes.
        used_for:
          $ref: '#/components/schemas/CXMLWebhookScriptType'
          description: >-
            Deprecated. Use `script_type`. Always the same value as
            `script_type`.
          deprecated: true
        primary_request_url:
          type: string
          format: uri
          description: Primary request url of the CXML Webhook.
        primary_request_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Primary request method of the CXML Webhook.
        fallback_request_url:
          type:
            - string
            - 'null'
          format: uri
          description: Fallback request url of the CXML Webhook.
        fallback_request_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Fallback request method of the CXML Webhook.
        status_callback_url:
          type:
            - string
            - 'null'
          format: uri
          description: Status callback url of the CXML Webhook.
        status_callback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Status callback method of the CXML Webhook.
      required:
        - id
        - name
        - script_type
        - used_for
        - primary_request_url
        - primary_request_method
        - fallback_request_url
        - fallback_request_method
        - status_callback_url
        - status_callback_method
      title: CXMLWebhook
    ResourceResponseCXMLWebhook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseCxmlWebhookType'
          description: The type of Resource
        cxml_webhook:
          $ref: '#/components/schemas/CXMLWebhook'
          description: An object containing the response data of the cXML Webhook
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - cxml_webhook
      title: ResourceResponseCXMLWebhook
    ResourceResponseCxmlScriptType:
      type: string
      enum:
        - cxml_script
      description: The type of Resource
      title: ResourceResponseCxmlScriptType
    CxmlScriptScriptType:
      type: string
      enum:
        - calling
        - messaging
      description: The script type the cXML Script is used for
      title: CxmlScriptScriptType
    CXMLScript:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a cXML Script.
        contents:
          type: string
          description: The cXML script contents
        request_count:
          type: integer
          description: The amout of times the cXML script has been requested
        last_accessed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time when the cXML script was last accessed
        request_url:
          type: string
          format: uri
          description: The URL where the cXML script can be accessed
        script_type:
          $ref: '#/components/schemas/CxmlScriptScriptType'
          description: The script type the cXML Script is used for
        display_name:
          type: string
          description: Display name of the cXML Script Fabric Resource
        status_callback_url:
          type:
            - string
            - 'null'
          format: uri
          description: The url that will send status updates for the cXML Script
        status_callback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for status callback URL
      required:
        - id
        - contents
        - request_count
        - last_accessed_at
        - request_url
        - script_type
        - display_name
      title: CXMLScript
    ResourceResponseCXMLScript:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseCxmlScriptType'
          description: The type of Resource
        cxml_script:
          $ref: '#/components/schemas/CXMLScript'
          description: An object containing the response data of the cXML Script
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - cxml_script
      title: ResourceResponseCXMLScript
    ResourceResponseCxmlApplicationType:
      type: string
      enum:
        - cxml_application
      description: The type of Resource
      title: ResourceResponseCxmlApplicationType
    CxmlApplication:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the cXML Application.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Project ID for the cXML Application
        friendly_name:
          type: string
          description: Display name of the cXML Application
        voice_url:
          type:
            - string
            - 'null'
          description: URL to handle incoming calls
        voice_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for voice URL
        voice_fallback_url:
          type:
            - string
            - 'null'
          description: Fallback URL for voice errors
        voice_fallback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for voice fallback URL
        status_callback:
          type:
            - string
            - 'null'
          format: uri
          description: URL to receive status callbacks
        status_callback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for status callbacks
        sms_url:
          type:
            - string
            - 'null'
          description: URL to handle incoming messages
        sms_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for SMS URL
        sms_fallback_url:
          type:
            - string
            - 'null'
          description: Fallback URL for SMS errors
        sms_fallback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for SMS fallback URL
        sms_status_callback:
          type:
            - string
            - 'null'
          description: URL to receive SMS status callbacks
        sms_status_callback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for SMS status callbacks
      required:
        - id
        - project_id
        - friendly_name
        - voice_url
        - voice_method
        - voice_fallback_url
        - voice_fallback_method
        - status_callback
        - status_callback_method
        - sms_url
        - sms_method
        - sms_fallback_url
        - sms_fallback_method
        - sms_status_callback
        - sms_status_callback_method
      title: CxmlApplication
    ResourceResponseCXMLApplication:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseCxmlApplicationType'
          description: The type of Resource
        cxml_application:
          $ref: '#/components/schemas/CxmlApplication'
          description: An object containing the response data of the cXML Application
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - cxml_application
      title: ResourceResponseCXMLApplication
    ResourceResponseDialogFlowAgentType:
      type: string
      enum:
        - dialogflow_agent
      description: The type of Resource
      title: ResourceResponseDialogFlowAgentType
    DialogflowAgent:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a Dialogflow Agent.
        say_enabled:
          type: boolean
          description: Whether to enable the 'say' feature
        say:
          type: string
          description: Default message to say
        voice:
          type: string
          description: Voice to use for speech
        display_name:
          type: string
          description: Display name of the Dialogflow Agent
        dialogflow_reference_id:
          $ref: '#/components/schemas/uuid'
          description: Dialogflow reference ID
        dialogflow_reference_name:
          type: string
          description: Dialogflow reference name
      required:
        - id
      title: DialogflowAgent
    ResourceResponseDialogFlowAgent:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseDialogFlowAgentType'
          description: The type of Resource
        dialogflow_agent:
          $ref: '#/components/schemas/DialogflowAgent'
          description: An object containing the response data of the Dialogflow Agent
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - dialogflow_agent
      title: ResourceResponseDialogFlowAgent
    ResourceResponseFsConnectorType:
      type: string
      enum:
        - freeswitch_connector
      description: The type of Resource
      title: ResourceResponseFsConnectorType
    FreeswitchConnector:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a FreeSWITCH Connector.
        name:
          type: string
          description: Name of the FreeSWITCH Connector
        caller_id:
          type:
            - string
            - 'null'
          description: Caller ID for the connector
        send_as:
          type:
            - string
            - 'null'
          description: Send as identifier
      required:
        - id
      title: FreeswitchConnector
    ResourceResponseFSConnector:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseFsConnectorType'
          description: The type of Resource
        freeswitch_connector:
          $ref: '#/components/schemas/FreeswitchConnector'
          description: An object containing the response data of the FreeSWITCH Connector
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - freeswitch_connector
      title: ResourceResponseFSConnector
    ResourceResponseRelayAppType:
      type: string
      enum:
        - relay_application
      description: The type of Resource
      title: ResourceResponseRelayAppType
    RelayApplication:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a Relay Application.
        name:
          type: string
          description: Name of the Relay Application
        topic:
          type: string
          description: Topic of the Relay Application
        call_status_callback_url:
          type:
            - string
            - 'null'
          format: uri
          description: Call status callback URL
      required:
        - id
        - name
        - topic
        - call_status_callback_url
      title: RelayApplication
    ResourceResponseRelayApp:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseRelayAppType'
          description: The type of Resource
        relay_application:
          $ref: '#/components/schemas/RelayApplication'
          description: An object containing the response data of the Relay Application
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - relay_application
      title: ResourceResponseRelayApp
    ResourceResponseSipEndpointType:
      type: string
      enum:
        - sip_endpoint
      description: The type of Resource
      title: ResourceResponseSipEndpointType
    Ciphers:
      type: string
      enum:
        - AEAD_AES_256_GCM_8
        - AES_256_CM_HMAC_SHA1_80
        - AES_CM_128_HMAC_SHA1_80
        - AES_256_CM_HMAC_SHA1_32
        - AES_CM_128_HMAC_SHA1_32
      title: Ciphers
    Codecs:
      type: string
      enum:
        - PCMU
        - PCMA
        - G722
        - G729
        - OPUS
        - OPUS@48000H@20I
        - OPUS@24000H@20I
        - OPUS@16000H@20I
        - OPUS@8000H@20I
        - VP8
        - H264
      title: Codecs
    Encryption:
      type: string
      enum:
        - required
        - optional
        - default
      title: Encryption
    CallHandlerType:
      type: string
      enum:
        - default
        - passthrough
        - block-pstn
        - resource
      title: CallHandlerType
    FabricSipEndpoint:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The id of the Sip Endpoint
        username:
          type: string
          description: The username of the Sip Endpoint
        caller_id:
          type: string
          description: The caller ID that will showup when dialing from this Sip Endpoint
        send_as:
          type: string
          description: >-
            The Sip username that will show up on the calle's side. Overrides
            the username.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers that can be enabled for calls on this Sip Endpoint.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs that can be enabled for calls on this Sip Endpoint.
        encryption:
          $ref: '#/components/schemas/Encryption'
          description: The set encryption type on the Sip Endpoint.
        call_handler:
          $ref: '#/components/schemas/CallHandlerType'
          description: >-
            Specify how the SIP endpoint will handle outbound calls.

            - **default**: The SIP endpoint will pull the outbound policy
            setting from the [SIP Profile
            Settings](https://my.signalwire.com?page=sip_profile/edit). This
            allows centralized management of outbound call behavior across
            multiple endpoints from a single configuration.

            - **passthrough**: The SIP endpoint will be allowed to dial PSTN
            numbers. This permits outbound calling to traditional phone numbers
            without restrictions.

            - **block-pstn**: The SIP endpoint will be blocked from dialing PSTN
            numbers. Use this to restrict the endpoint from initiating calls to
            the public telephone network.

            - **resource**: Outbound calls from this SIP endpoint will dial the
            specified resource and execute its instructions. Requires setting
            `calling_handler_resource_id` to a valid resource. This enables
            custom call handling workflows for outbound calls.
        calling_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            If `call_handler` is set to `resource`, this field expects the id of
            the set resouce. Will be `null` otherwise.
      required:
        - id
        - username
        - caller_id
        - send_as
        - ciphers
        - codecs
        - encryption
        - call_handler
        - calling_handler_resource_id
      title: FabricSipEndpoint
    ResourceResponseSipEndpoint:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseSipEndpointType'
          description: The type of Resource
        sip_endpoint:
          $ref: '#/components/schemas/FabricSipEndpoint'
          description: An object containing the response data of the SIP Endpoint
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - sip_endpoint
      title: ResourceResponseSipEndpoint
    ResourceResponseSipGatewayType:
      type: string
      enum:
        - sip_gateway
      description: The type of Resource
      title: ResourceResponseSipGatewayType
    SipGateway:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the SIP Gateway.
        uri:
          type: string
          description: The URI for the SIP Gateway.
        name:
          type: string
          description: Display name of the SIP Gateway.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs.
        encryption:
          $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement.
      required:
        - id
        - uri
        - name
        - ciphers
        - codecs
        - encryption
      title: SipGateway
    ResourceResponseSipGateway:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseSipGatewayType'
          description: The type of Resource
        sip_gateway:
          $ref: '#/components/schemas/SipGateway'
          description: An object containing the response data of the SIP Gateway
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - sip_gateway
      title: ResourceResponseSipGateway
    ResourceResponseSubscriberType:
      type: string
      enum:
        - subscriber
      description: The type of Resource
      title: ResourceResponseSubscriberType
    Subscriber:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Subscriber.
        email:
          type: string
          description: Email of the Subscriber.
        first_name:
          type:
            - string
            - 'null'
          description: First name of the Subscriber, or `null` when not set.
        last_name:
          type:
            - string
            - 'null'
          description: Last name of the Subscriber, or `null` when not set.
        display_name:
          type:
            - string
            - 'null'
          description: Display name of the Subscriber, or `null` when not set.
        job_title:
          type:
            - string
            - 'null'
          description: Job title of the Subscriber, or `null` when not set.
        time_zone:
          type: string
          description: Time zone of the Subscriber. Defaults to `GMT`.
        country:
          type:
            - string
            - 'null'
          description: Country of the Subscriber, or `null` when not set.
        company_name:
          type:
            - string
            - 'null'
          description: Company name of the Subscriber, or `null` when not set.
      required:
        - id
        - email
        - first_name
        - last_name
        - display_name
        - job_title
        - time_zone
        - country
        - company_name
      title: Subscriber
    ResourceResponseSubscriber:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseSubscriberType'
          description: The type of Resource
        subscriber:
          $ref: '#/components/schemas/Subscriber'
          description: >-
            An object containing the response data of the
            [Subscriber](/docs/platform/subscribers).
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - subscriber
      title: ResourceResponseSubscriber
    ResourceResponseSwmlWebhookType:
      type: string
      enum:
        - swml_webhook
      description: The type of Resource
      title: ResourceResponseSwmlWebhookType
    SwmlWebhookScriptType:
      type: string
      enum:
        - calling
        - messaging
      description: >-
        Whether the SWML Webhook handles inbound calls or inbound messages.
        Determines the payload SignalWire POSTs to `primary_request_url`.
      title: SwmlWebhookScriptType
    SwmlWebhookUsedFor:
      type: string
      enum:
        - calling
        - messaging
      description: Deprecated. Use `script_type`. Always the same value as `script_type`.
      title: SwmlWebhookUsedFor
      deprecated: true
    SWMLWebhook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the SWML Webhook.
        name:
          type: string
          description: Name of the SWML Webhook.
        script_type:
          $ref: '#/components/schemas/SwmlWebhookScriptType'
          description: >-
            Whether the SWML Webhook handles inbound calls or inbound messages.
            Determines the payload SignalWire POSTs to `primary_request_url`.
        used_for:
          $ref: '#/components/schemas/SwmlWebhookUsedFor'
          description: >-
            Deprecated. Use `script_type`. Always the same value as
            `script_type`.
          deprecated: true
        primary_request_url:
          type: string
          format: uri
          description: >-
            Primary URL SignalWire fetches the SWML document from when the
            webhook fires. The webhook payload depends on `script_type`: for
            `calling`, see the [SWML inbound call
            webhook](/docs/apis/rest/webhooks/inbound-call-webhook); for
            `messaging`, see the [SWML inbound message
            webhook](/docs/apis/rest/webhooks/inbound-message-webhook).
        primary_request_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Primary request method of the SWML Webhook.
        fallback_request_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            Fallback URL SignalWire fetches the SWML document from if the
            primary URL fails. Receives the same payload as
            `primary_request_url` — see the [SWML inbound call
            webhook](/docs/apis/rest/webhooks/inbound-call-webhook) or [SWML
            inbound message
            webhook](/docs/apis/rest/webhooks/inbound-message-webhook) depending
            on `script_type`.
        fallback_request_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Fallback request method of the SWML Webhook.
        status_callback_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            URL to receive message status callback events for outbound messages
            sent by this webhook (`reply` or `send_sms`). See the [Message
            status callback](/docs/apis/rest/webhooks/message-status-callback)
            webhook for the payload your URL will receive.
        status_callback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Status callback method of the SWML Webhook.
      required:
        - id
        - name
        - script_type
        - used_for
        - primary_request_url
        - primary_request_method
        - fallback_request_url
        - fallback_request_method
        - status_callback_url
        - status_callback_method
      title: SWMLWebhook
    ResourceResponseSWMLWebhook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseSwmlWebhookType'
          description: The type of Resource
        swml_webhook:
          $ref: '#/components/schemas/SWMLWebhook'
          description: An object containing the response data of the SWML Webhook
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - swml_webhook
      title: ResourceResponseSWMLWebhook
    ResourceResponseSwmlScriptType:
      type: string
      enum:
        - swml_script
      description: The type of Resource
      title: ResourceResponseSwmlScriptType
    CallingSwmlScriptScriptType:
      type: string
      enum:
        - calling
      description: Set to `calling` for SWML Scripts that handle inbound or outbound calls.
      title: CallingSwmlScriptScriptType
    CallingSwmlScriptContents:
      type: object
      properties: {}
      description: >-
        The calling SWML document executed when this script runs. Uses [calling
        SWML methods](/docs/swml/reference/calling).
      title: CallingSwmlScriptContents
    CallingSwmlScriptStatusCallbackMethod:
      type: string
      enum:
        - POST
      description: HTTP method used for status callbacks.
      title: CallingSwmlScriptStatusCallbackMethod
    CallingSwmlScript:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a SWML Script.
        display_name:
          type: string
          description: The displayed name of the SWML script.
        script_type:
          $ref: '#/components/schemas/CallingSwmlScriptScriptType'
          description: >-
            Set to `calling` for SWML Scripts that handle inbound or outbound
            calls.
        request_url:
          type: string
          format: uri
          description: URL where this SWML Script is hosted.
        contents:
          $ref: '#/components/schemas/CallingSwmlScriptContents'
          description: >-
            The calling SWML document executed when this script runs. Uses
            [calling SWML methods](/docs/swml/reference/calling).
        status_callback_url:
          type: string
          format: uri
          description: >-
            URL that receives status callbacks for messages sent or calls made
            by this script.
        status_callback_method:
          $ref: '#/components/schemas/CallingSwmlScriptStatusCallbackMethod'
          description: HTTP method used for status callbacks.
      required:
        - id
        - display_name
        - script_type
        - request_url
        - contents
      description: >-
        A SWML Script that handles inbound or outbound calls. The `contents`
        field carries a [calling SWML document](/docs/swml/reference/calling).
      title: CallingSwmlScript
    MessagingSwmlScriptScriptType:
      type: string
      enum:
        - messaging
      description: >-
        Set to `messaging` for SWML Scripts that handle inbound SMS or MMS
        messages.
      title: MessagingSwmlScriptScriptType
    MessagingSwmlScriptContents:
      type: object
      properties: {}
      description: >-
        The messaging SWML document executed when this script runs. Uses
        [messaging SWML methods](/docs/swml/reference/messaging).
      title: MessagingSwmlScriptContents
    MessagingSwmlScript:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of a SWML Script.
        display_name:
          type: string
          description: The displayed name of the SWML script.
        script_type:
          $ref: '#/components/schemas/MessagingSwmlScriptScriptType'
          description: >-
            Set to `messaging` for SWML Scripts that handle inbound SMS or MMS
            messages.
        request_url:
          type: string
          format: uri
          description: URL where this SWML Script is hosted.
        contents:
          $ref: '#/components/schemas/MessagingSwmlScriptContents'
          description: >-
            The messaging SWML document executed when this script runs. Uses
            [messaging SWML methods](/docs/swml/reference/messaging).
      required:
        - id
        - display_name
        - script_type
        - request_url
        - contents
      description: >-
        A SWML Script that handles inbound SMS or MMS messages. The `contents`
        field carries a [messaging SWML
        document](/docs/swml/reference/messaging).
      title: MessagingSwmlScript
    SwmlScript:
      oneOf:
        - $ref: '#/components/schemas/CallingSwmlScript'
        - $ref: '#/components/schemas/MessagingSwmlScript'
      description: >-
        A SWML Script — either a [Calling Script](#schema/CallingSwmlScript) for
        inbound or

        outbound calls, or a [Messaging Script](#schema/MessagingSwmlScript) for
        inbound SMS or

        MMS messages. The `script_type` field on each script (`"calling"` or
        `"messaging"`)

        identifies which kind it is.
      title: SwmlScript
    ResourceResponseSWMLScript:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseSwmlScriptType'
          description: The type of Resource
        swml_script:
          $ref: '#/components/schemas/SwmlScript'
          description: An object containing the response data of the SWML Script
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - swml_script
      title: ResourceResponseSWMLScript
    ResourceResponseConferenceRoomType:
      type: string
      enum:
        - video_room
      description: The type of Resource
      title: ResourceResponseConferenceRoomType
    ConferenceRoomQuality:
      type: string
      enum:
        - 1080p
        - 720p
      default: 720p
      description: The viudeo quality of the Conference Room.
      title: ConferenceRoomQuality
    ConferenceRoomFps:
      type: string
      enum:
        - '30'
        - '20'
      description: >-
        The frames-per-second (fps) of the participants videos in the
        conference.
      title: ConferenceRoomFps
    Layout:
      type: string
      enum:
        - grid-responsive
        - grid-responsive-mobile
        - highlight-1-responsive
        - 1x1
        - 2x1
        - 2x2
        - 5up
        - 3x3
        - 4x4
        - 5x5
        - 6x6
        - 8x8
        - 10x10
      title: Layout
    ConferenceRoomMeta:
      type: object
      properties: {}
      description: Metadata of the conference.
      title: ConferenceRoomMeta
    ConferenceRoom:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique id of the Conference Room
        name:
          type: string
          description: The name of the Conference Room
        description:
          type:
            - string
            - 'null'
          maxLength: 3000
          description: The description of the Conference Room, or `null` when not set.
        display_name:
          type: string
          maxLength: 200
          description: Display name of the Conference Room
        max_members:
          type: integer
          minimum: 0
          maximum: 300
          description: Maximum number of members allowed in the conference room
        quality:
          $ref: '#/components/schemas/ConferenceRoomQuality'
          description: The viudeo quality of the Conference Room.
        fps:
          $ref: '#/components/schemas/ConferenceRoomFps'
          description: >-
            The frames-per-second (fps) of the participants videos in the
            conference.
        join_from:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The time users are allowed to start joining the conference. Joining
            before this time will result in failure to join the conference.
        join_until:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The time users are allowed to until the conference is locked.
            Attempting to join the conference after the set time will result in
            failure to join the conference.
        remove_at:
          type:
            - string
            - 'null'
          format: date-time
          description: The time to remove all participants from the conference.
        remove_after_seconds_elapsed:
          type:
            - integer
            - 'null'
          minimum: 0
          maximum: 200000
          description: >-
            The amount of time in seconds to remove a particpant from a
            conference after they join.
        layout:
          $ref: '#/components/schemas/Layout'
          description: The video layout of the conference.
        record_on_start:
          type: boolean
          description: Starts recording when the conference starts.
        tone_on_entry_and_exit:
          type: boolean
          description: Plays a tone when a participant joins or leaves the conference.
        room_join_video_off:
          type: boolean
          description: >-
            Turns the conference video off when the participant joins the room
            if `true`.
        user_join_video_off:
          type: boolean
          description: >-
            Turns the participants video off when the participant joins the room
            if `true`.
        enable_room_previews:
          type: boolean
          description: Enables live video room previews for the conference.
        sync_audio_video:
          type:
            - boolean
            - 'null'
          description: Syncs the participants audio and video.
        meta:
          $ref: '#/components/schemas/ConferenceRoomMeta'
          description: Metadata of the conference.
        prioritize_handraise:
          type: boolean
          description: >-
            Indicator if the Conference Room will prioritize showing
            participants utilizing the hand raised feature.
      required:
        - id
        - name
        - description
        - display_name
        - max_members
        - quality
        - fps
        - join_from
        - join_until
        - remove_at
        - remove_after_seconds_elapsed
        - layout
        - record_on_start
        - tone_on_entry_and_exit
        - room_join_video_off
        - user_join_video_off
        - enable_room_previews
        - sync_audio_video
        - meta
        - prioritize_handraise
      title: ConferenceRoom
    ResourceResponseConferenceRoom:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        type:
          $ref: '#/components/schemas/ResourceResponseConferenceRoomType'
          description: The type of Resource
        conference_room:
          $ref: '#/components/schemas/ConferenceRoom'
          description: An object containing the response data of the Conference Room
      required:
        - id
        - project_id
        - display_name
        - created_at
        - updated_at
        - type
        - conference_room
      title: ResourceResponseConferenceRoom
    ResourceResponse:
      oneOf:
        - $ref: '#/components/schemas/ResourceResponseAI'
        - $ref: '#/components/schemas/ResourceResponseRemoteAIAgent'
        - $ref: '#/components/schemas/ResourceResponseCallFlow'
        - $ref: '#/components/schemas/ResourceResponseCXMLWebhook'
        - $ref: '#/components/schemas/ResourceResponseCXMLScript'
        - $ref: '#/components/schemas/ResourceResponseCXMLApplication'
        - $ref: '#/components/schemas/ResourceResponseDialogFlowAgent'
        - $ref: '#/components/schemas/ResourceResponseFSConnector'
        - $ref: '#/components/schemas/ResourceResponseRelayApp'
        - $ref: '#/components/schemas/ResourceResponseSipEndpoint'
        - $ref: '#/components/schemas/ResourceResponseSipGateway'
        - $ref: '#/components/schemas/ResourceResponseSubscriber'
        - $ref: '#/components/schemas/ResourceResponseSWMLWebhook'
        - $ref: '#/components/schemas/ResourceResponseSWMLScript'
        - $ref: '#/components/schemas/ResourceResponseConferenceRoom'
      title: ResourceResponse
    ResourcePaginationResponse:
      type: object
      properties:
        self:
          type: string
          format: uri
          description: The link to the current page
        first:
          type: string
          format: uri
          description: The link to the first page
        next:
          type: string
          format: uri
          description: The link to the next page
        prev:
          type: string
          format: uri
          description: The link to the previous page
      required:
        - self
        - first
      title: ResourcePaginationResponse
    ResourceListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceResponse'
          description: An array of objects that contain a list of Resource data
        links:
          $ref: '#/components/schemas/ResourcePaginationResponse'
          description: Object containing pagination links
      required:
        - data
        - links
      title: ResourceListResponse
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "data": [
    {
      "ai_agent": {
        "agent_id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
        "name": "Support Assistant",
        "prompt": {
          "text": "You are a helpful customer support assistant."
        }
      },
      "created_at": "2024-05-06T12:20:00Z",
      "display_name": "Support Assistant",
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "type": "ai_agent",
      "updated_at": "2024-05-06T12:25:00Z"
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/resources?page_number=0&page_size=50"
  }
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});

const response = await client.fabric.resources.list();
for (const resource of response.data ?? []) {
  console.log(`${resource.type}: ${resource.display_name} (${resource.id})`);
}
```