List | Flockx - Your Team of AIs

List, search, and filter for channels in which your organization is a participant.

Authorizationstring

API Key authentication via header

sizeintegerOptional1-100Defaults to 50

pageintegerOptional>=1Defaults to 1

agentstring or nullOptionalformat: "uuid"

Filter channels where this agent is a participant

is_ownerboolean or nullOptional

Filter channels where the organization for the user making the request is the owner

is_multi_orgboolean or nullOptional

Filter channels by multi-org status. True = only multi-org channels, False = exclude multi-org channels, None = all channels

channel_typelist of enums or enum or nullOptional

Filter channels by type. Can be a single type or list of types.

communication_typeenum or nullOptional

Filter channels by type of communication

Allowed values:

sourceenum or nullOptional

Filter channels by source

Allowed values:

participant_agentslist of strings or nullOptional

Filter channels that include these agent participants

participant_userslist of strings or nullOptional

Filter channels that include these user participants

is_pinnedboolean or nullOptional

Filter channels by pinned status. True = only pinned channels, False = exclude pinned channels, None = all channels

Successful Response

itemslist of objects

metaobject

1	{
2	"items": [
3	{
4	"id": "foo",
5	"type": "websocket",
6	"channel_type": "chat",
7	"name": "foo",
8	"participants": [
9	{
10	"type": "foo",
11	"user_id": "foo",
12	"id": "foo",
13	"display_name": "foo",
14	"image_url": "foo",
15	"is_owner": true
16	}
17	],
18	"created_at": "foo",
19	"modified": "foo",
20	"meta_data": {},
21	"source": "flockx",
22	"agent_invocation_behavior": "at_mentions_only"
23	}
24	],
25	"meta": {
26	"total": 42,
27	"has_next": true,
28	"has_previous": true,
29	"page": 42
30	}
31	}

1	curl https://api.flockx.io/api/v1/channels \
2	-H "Authorization: <apiKey>"