Chatters
List Chatters
Returns a paginated list of chatters in your organization, with each user's roles and team memberships included on every row. Use to populate chatter-selector dropdowns before hitting Compare Chatters or Chatter Report. Requires permission api_chat_chatters_list.
https://public-api.buffmetrics.comGET/v1/chatters
Bearer
Authorization
defaultAuthorizationBearer <token>Send your FansMetric API key as a Bearer token in the Authorization header.
In: header
Query Parameters
team_idsarrayComma-separated team UUIDs. Filters to users in any of these teams (OR). Omit for every user in the org.
include_deactivatedstringtrueto include deactivated members. Defaultfalse.limitintegerPage size. Default
100, max500.offsetintegerNumber of rows to skip. Default
0.
curl --request GET "https://public-api.buffmetrics.com/v1/chatters?team_ids=sample_team_ids&include_deactivated=sample_include_deactivated&limit=20" \
--header "Authorization: Bearer YOUR_API_KEY"Response
200{
"data":{
"chatters":[
0:{
"id":"b7a9e0f1-2fa4-4d0b-9c2a-6c4d0b41f2c7"
"name":"Alex Chen"
"email":"alex@example.com"
"is_deactivated":false
"roles":[
0:{
"id":"r_01"
"name":"Chatter"
"color":"#22c55e"
}
1:{
"id":"r_02"
"name":"Team Lead"
"color":"#3b82f6"
}
]
"teams":[
0:{
"id":"t_01"
"name":"Team A"
}
]
}
1:{
"id":"c5d6e7f8-9012-3456-7890-abcdef012345"
"name":"Jordan Rivera"
"email":"jordan@example.com"
"is_deactivated":false
"roles":[
0:{
"id":"r_01"
"name":"Chatter"
"color":"#22c55e"
}
]
"teams":[]
}
]
"total":247
"limit":100
"offset":0
}
"_pagination":{
"next_page":"/v1/chatters?offset=100&limit=100"
}
"_meta":{
"_credits":{
"used":1
}
"_rate_limits":{
"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}