Retrieve the current username and ID's of each member in your property.
curl --location --request POST 'https://sux.chatsight.ai/api/properties/members/list' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"property_id": <PROPERTY_ID>
}'
Response Format
Members are compiled and returned as an Array
of Arrays
in the format of:
[ [ <ID> , <USERNAME> ] , [ <ID>, <USERNAME> ] ]
Data Availability
We do not scrape native API data for this information. We rely on our integration to copy-on-write
when it has the chance to store updated information from events captured. Member data is written on events like USER_JOIN
, USER_UPDATE
, or VERIFICATION_SUCCESS
. You can wait for enough time for member data to be populated or request a force fetch as described below.
Adding the property key force
, will trigger a force pull. You may use force once per 24 hours, per organization. You should only use it once per new property, as data is updated as it happens already. This feature is purely for enabling the indexing of already established properties.
This force
operation is asynchronous and may not be reflected for a few minutes.
curl --location --request POST 'https://sux.chatsight.ai/api/properties/members/list' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"property_id": <PROPERTY_ID>,
"force": true
}'