List | Flockx API Documentation

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_typeenum or nullOptional

Filter channels by type

Allowed values:

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

Successful Response

itemslist of objects

metaobject

1	import requests
2
3	url = "https://api.flockx.io/api/v1/channels"
4
5	headers = {"Authorization": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())