---
title: "List Message Brokers"
method: GET
path: "/api/v1/message-brokers"
tags: ["Message Brokers"]
---

# List Message Brokers

`GET /api/v1/message-brokers`

Retrieves a paginated list of message brokers.

## Query parameters

- `filter[name]` string
- `filter[description]` string
- `filter[host]` string
- `filter[protocol]` string
- `filter[auth_type]` string
- `filter[port]` string
- `include` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- MessageBrokersListResponse
  - `data` MessageBrokers[]
    - `id` integer — Unique identifier
    - `description` string
    - `host` string
    - `port` integer
    - `protocol` 'HTTP' | 'FTP' | 'SFTP' | 'FTPS' | 'S3' | 'MySQL' | 'PGSQL' | 'SQLSRV' | 'OCI'
    - `auth_type` string
    - `variables` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string
    - `flows` object[]
    - `message_broker_queues` object[]
    - `message_broker_queues_count` object[]
    - `flow_message_broker_queues` object[]
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)