Skip to main content
Tomt
April 20, 2023
Solved

Excluding private conversations and messages

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?

jason
jasonAnswer
Fronteer
April 20, 2023

Hi @Tomt , 

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:

  1. Use an API token that has Shared Resource scopes only (so it can not access any private conversations/inboxes)
  2. 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).
  3. 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!

View in thread

3 replies

TomtAuthor
April 20, 2023

I guess one of the followup questions to this, what does is_private mean? 

TomtAuthor
April 20, 2023

Another followup is does having an api token scope of Shared Resources mean that the client won’t see any is_private conversations/messages?

jason
jasonAnswer
Fronteer
April 20, 2023

Hi @Tomt , 

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:

  1. Use an API token that has Shared Resource scopes only (so it can not access any private conversations/inboxes)
  2. 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).
  3. 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!

Terms & ConditionsAccessibility statement