List filtered Thread entities
Thread Collection API
Multiple access controls based on provided filters:
Filter combination 1: conversation_id, provider_id
Requirement 1:
User must be a direct member of provider organization (1) to access provider-only threads 🔐
Requirement 2:
Conversation ID 1 must belong to provider organization (1) 🔐
Filter combination 2: conversation_id, customer_id
Requirement 1:
User must be a direct member of customer organization (1) to access customer-only threads 🔐
Requirement 2:
Conversation ID 1 must belong to customer organization (1) 🔐
Filter combination 3: provider_id
Requirement 1:
Filter combination 4: customer_id
Requirement 1:
User must be a direct member of customer organization (1) to list customer-only threads 🔐
Filter combination 5: conversation_id, provider_id, customer_id
Requirement 1:
At least one of the following conditions must be met:
- User is a direct member of the customer organization 🔐
- User is a member of the service provider organization that has a customer organization relationship. 🔐
Requirement 2:
Conversation ID 1 must belong to provider (1) and customer (1) organizations 🔐
Filter combination 6: provider_id, customer_id
Requirement 1:
At least one of the following conditions must be met:
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Authorization: Bearer <token> header is required for authorization, requests without a valid and active authorization header will be denied access with a 401 Not Authorized HTTP status code.
Query param filters, URL encoded JSON object with fields: archived_at, conversation_id, created_at, customer_id, id, parent_message_id, parent_thread_id, provider_id, title, updated_at, user_id
Example:
/api/threads?filters={"conversation_id": ..., "customer_id": ..., "parent_message_id": ..., "parent_thread_id": ..., "provider_id": ..., "title": ..., "user_id": ...}Response
Successful response
The response is of type object.