Is there a query that can be passed into the list conversations and/or search end point to exclude conversations (eventually messages) that are is_private?
Solved
Excluding private conversations and messages
Best answer by jason
Hi
Is there a query that can be passed into the list conversations and/or search end point to exclude conversations (eventually messages) that are is_private?
Sort of, yes. Your options are:
- Use an API token that has Shared Resource scopes only (so it can not access any private conversations/inboxes)
- If using the GET /conversations endpoint, consider the List Inbox Conversations endpoint to instead list conversations present in a specific inbox (this will exclude private conversations, assuming you’re fetching from an inbox in a shared workspace).
- If using the GET /conversations/search/:query endpoint, consider adding filters for specific inboxes; this will have a similar effect as described in #2.
I guess one of the followup questions to this, what does is_private mean?
The is_private field on a conversation being true indicates that every inbox the conversation is present in is an individual inbox (rather than a shared workspace inbox).
Another followup is does having an api token scope of Shared Resources mean that the client won’t see any is_private conversations/messages?
Not necessarily; an API token can have multiple scopes. If a token only has the Shared Resources scope, it would not be able to access any conversations present in individual inboxes.
Hope this is all helpful!
Another followup is does having an api token scope of Shared Resources mean that the client won’t see any is_private conversations/messages?
+8Hi
Is there a query that can be passed into the list conversations and/or search end point to exclude conversations (eventually messages) that are is_private?
Sort of, yes. Your options are:
- Use an API token that has Shared Resource scopes only (so it can not access any private conversations/inboxes)
- If using the GET /conversations endpoint, consider the List Inbox Conversations endpoint to instead list conversations present in a specific inbox (this will exclude private conversations, assuming you’re fetching from an inbox in a shared workspace).
- If using the GET /conversations/search/:query endpoint, consider adding filters for specific inboxes; this will have a similar effect as described in #2.
I guess one of the followup questions to this, what does is_private mean?
The is_private field on a conversation being true indicates that every inbox the conversation is present in is an individual inbox (rather than a shared workspace inbox).
Another followup is does having an api token scope of Shared Resources mean that the client won’t see any is_private conversations/messages?
Not necessarily; an API token can have multiple scopes. If a token only has the Shared Resources scope, it would not be able to access any conversations present in individual inboxes.
Hope this is all helpful!
Login to the community
No account yet? Create an account
Use your Front credentials
Log in with Frontor
Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.