List

1 curl https://api.flockx.io/api/v1/channels

1 { 2 "items": [ 3 { 4 "id": "id", 5 "type": "websocket", 6 "channel_type": "chat", 7 "name": "name", 8 "participants": [ 9 { 10 "type": "authenticated_user", 11 "user_id": "user_id", 12 "display_name": "display_name", 13 "image_url": "image_url" 14 }, 15 { 16 "type": "authenticated_user", 17 "user_id": "user_id", 18 "display_name": "display_name", 19 "image_url": "image_url" 20 } 21 ], 22 "created_at": "created_at", 23 "modified": "modified" 24 }, 25 { 26 "id": "id", 27 "type": "websocket", 28 "channel_type": "chat", 29 "name": "name", 30 "participants": [ 31 { 32 "type": "authenticated_user", 33 "user_id": "user_id", 34 "display_name": "display_name", 35 "image_url": "image_url" 36 }, 37 { 38 "type": "authenticated_user", 39 "user_id": "user_id", 40 "display_name": "display_name", 41 "image_url": "image_url" 42 } 43 ], 44 "created_at": "created_at", 45 "modified": "modified" 46 } 47 ], 48 "meta": { 49 "total": 1, 50 "has_next": true, 51 "has_previous": true, 52 "page": 1 53 } 54 }

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

Query parameters

sizeintegerOptional>=1<=100Defaults to 50

pageintegerOptional>=1Defaults to 1

agentstringOptionalformat: "uuid"

Filter channels where this agent is a participant

is_ownerbooleanOptional

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

channel_typeenumOptional

Filter channels by type

Allowed values:

Response

Successful Response

itemslist of objects

metaobject