> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# list

> List Relay application resources.

List Relay application resources in the project.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fabric/resources/relay_applications:
    get:
      operationId: list_relay_applications
      summary: List Relay applications
      description: >-
        A list of Relay Applications


        #### 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_relayApplication
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayApplicationListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
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
    RelayApplicationResponseType:
      type: string
      enum:
        - relay_application
      description: Type of the Fabric Resource
      title: RelayApplicationResponseType
    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
    RelayApplicationResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Relay Application.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the Relay Application Fabric Resource
        type:
          $ref: '#/components/schemas/RelayApplicationResponseType'
          description: Type of the Fabric 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.
        relay_application:
          $ref: '#/components/schemas/RelayApplication'
          description: Relay Application data.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - relay_application
      title: RelayApplicationResponse
    RelayApplicationAddressPaginationResponse:
      type: object
      properties:
        self:
          type: string
          description: Self link for the current page
        first:
          type: string
          description: Link to the first page
        next:
          type: string
          description: Link to the next page
        prev:
          type: string
          description: Link to the previous page
      required:
        - self
        - first
      title: RelayApplicationAddressPaginationResponse
    RelayApplicationListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RelayApplicationResponse'
          description: An array of objects that contain a list of Relay Application data
        links:
          $ref: '#/components/schemas/RelayApplicationAddressPaginationResponse'
          description: Object containing pagination links
      required:
        - data
        - links
      title: RelayApplicationListResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    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": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Customer Service Bot",
      "type": "relay_application",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "relay_application": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Booking Assistant",
        "topic": "booking",
        "call_status_callback_url": "https://example.com/callbacks"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
    "first": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
    "next": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application",
    "prev": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application"
  }
}
```

## **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.relayApplications.list();
for (const item of response.data ?? []) {
  console.log(`${item.display_name}: ${item.id}`);
}
```