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.fansmetric.com

GET/v1/chatters

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Query Parameters

team_idsarray
Comma-separated team UUIDs. Filters to users in any of these teams (OR). Omit for every user in the org.
include_deactivatedboolean
true to include deactivated members. Default false.
limitinteger
Page size. Default 100, max 500.
offsetinteger
Number of rows to skip. Default 0.

Response Fields

data.chatters[]array
Users in this page, sorted by name ascending.
data.chatters[].idstring
FansMetric user UUID. Pass this to Compare Chatters or Chatter Report.
data.chatters[].namestring
Display name.
data.chatters[].emailstring
Sign-in email address.
data.chatters[].is_deactivatedboolean
Whether the user is deactivated in the org.
data.chatters[].roles[]array
Roles: id, name, color (hex or CSS colour for UI badges).
data.chatters[].teams[]array
Teams: id, name.
data.totalinteger
Total users matching the filters (across all pages).
data.limitinteger
Effective page size.
data.offsetinteger
Effective offset.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_pagination.next_pagestring
Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.chatters[]	array	Users in this page, sorted by name ascending.
data.chatters[].id	string	FansMetric user UUID. Pass this to Compare Chatters or Chatter Report.
data.chatters[].name	string	Display name.
data.chatters[].email	string	Sign-in email address.
data.chatters[].is_deactivated	boolean	Whether the user is deactivated in the org.
data.chatters[].roles[]	array	Roles: `id`, `name`, `color` (hex or CSS colour for UI badges).
data.chatters[].teams[]	array	Teams: `id`, `name`.
data.total	integer	Total users matching the filters (across all pages).
data.limit	integer	Effective page size.
data.offset	integer	Effective offset.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_pagination.next_page	string	Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request GET "https://public-api.fansmetric.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
}
}
}

Chat Chart

Compare Chatters