ListOrgSubscriptions

Lists subscriptions for multiple users in an org.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request for listing subscriptions (for many users) for an org.

event_type

enum<string>

event_type

optional

Optional.
Used by matrix-notify to get settings in bulk for a particular event type.

Allowed values:

DUMMY_APPLICATIONDUMMY_APPLICATION_STORAGEDUMMY_APPLICATION_COMPUTEVOICE_ANALYTICSVOICE_ANALYTICS_FLAG_OCCURRENCEVOICE_ANALYTICS_FLAG_NEEDS_REVIEWVOICE_ANALYTICS_BILLING_REPORTVOICE_ANALYTICS_FLAG_SUMMARYVOICE_ANALYTICS_PHRASE_CORRECTIONVOICE_ANALYTICS_CREATE_TRANSCRIPTVOICE_ANALYTICS_CREATE_SENTIMENTVOICE_ANALYTICS_CREATE_SUMMARYOMNICHANNELOMNICHANNEL_PROJECTOMNICHANNEL_CAMPAIGNOMNICHANNEL_DAILY_PROJECT_REPORTOMNICHANNEL_DAILY_CONVERSATION_REPORTOMNICHANNEL_AGENT_ASSIGN_CONVERSATIONOMNICHANNEL_AGENT_UNASSIGN_CONVERSATIONOMNICHANNEL_AGENT_REASSIGN_CONVERSATIONOMNICHANNEL_T10OMNICHANNEL_CUSTOMER_TEXT_MESSAGEOMNICHANNEL_AGENT_TEXT_MESSAGEOMNICHANNEL_FINISH_WRAP_UPOMNICHANNEL_BEGIN_WRAP_UPOMNICHANNEL_T11OMNICHANNEL_CREATE_CONVERSATIONOMNICHANNEL_AGENT_SUSPENDOMNICHANNEL_CLOSE_CONVERSATIONOMNICHANNEL_MANAGER_TEXT_MESSAGEOMNICHANNEL_UPDATE_CAMPAIGNOMNICHANNEL_SET_CONVERSATION_COLLECTED_DATAOMNICHANNEL_ARCHIVE_CAMPAIGNOMNICHANNEL_PAUSE_CAMPAIGNOMNICHANNEL_RESUME_CAMPAIGNOMNICHANNEL_START_CAMPAIGNOMNICHANNEL_SCHEDULE_MODULEOMNICHANNEL_START_MODULEOMNICHANNEL_PAUSE_MODULEOMNICHANNEL_RESUME_MODULEOMNICHANNEL_ERROR_MODULEOMNICHANNEL_SUCCESS_MODULEOMNICHANNEL_FAIL_MODULEOMNICHANNEL_COMPLETE_MODULEOMNICHANNEL_ARCHIVE_MODULEOMNICHANNEL_UPDATE_MODULEOMNICHANNEL_MODULE_SMS_MESSAGE_SENTOMNICHANNEL_COMPLETE_CAMPAIGNOMNICHANNEL_MODULE_INITIAL_REPLYOMNICHANNEL_TASK_MESSAGE_SENTOMNICHANNEL_CONNECTED_INBOX_POLLOMNICHANNEL_CONNECTED_INBOX_CREATEDOMNICHANNEL_AGENT_MESSAGE_UNITSOMNICHANNEL_MANAGER_MESSAGE_UNITSOMNICHANNEL_CUSTOMER_MESSAGE_UNITSOMNICHANNEL_SYSTEM_MESSAGE_UNITSOMNICHANNEL_PAYMENT_LINK_SENTOMNICHANNEL_MANUAL_APPROVE_TASK_ACCEPTEDOMNICHANNEL_MANUAL_APPROVE_TASK_REJECTEDOMNICHANNEL_MANUAL_APPROVE_TASK_TIMEOUTOMNICHANNEL_MANUAL_APPROVE_TASK_REQUEUEOMNICHANNEL_TRANSCRIPT_SAVEDOMNICHANNEL_MESSAGE_SENTOMNICHANNEL_PROVIDER_RESPONSEOMNICHANNEL_PROVIDER_MESSAGE_FAILEDASM_AGENT_LOGINASM_OPEN_VOICEASM_OPEN_OMNI_AGENTASM_ACTIVATE_CONVERSATIONASM_DEACTIVATE_CONVERSATIONASM_AGENT_STATE_CHANGEDASM_AGENT_LOGOUTASM_PAUSE_EVENTASM_RESUME_EVENTASM_CONVERSATION_PULLED_EVENTSCORECARDS_CREATE_QUESTION_EVENTSCORECARDS_UPDATE_QUESTION_EVENTSCORECARDS_DELETE_QUESTION_EVENTSCORECARDS_CREATE_SCORECARD_EVENTSCORECARDS_UPDATE_SCORECARD_EVENTSCORECARDS_DELETE_SCORECARD_EVENTSCORECARDS_CLONE_SCORECARD_EVENTSCORECARDS_CREATE_EVALUATION_EVENTSCORECARDS_DELETE_EVALUATION_EVENTSCORECARDS_CREATE_SECTION_EVENTSCORECARDS_UPDATE_SECTION_EVENTSCORECARDS_DELETE_SECTION_EVENTSCORECARDS_CREATE_CATEGORY_EVENTSCORECARDS_UPDATE_CATEGORY_EVENTSCORECARDS_DELETE_CATEGORY_EVENTSCORECARDS_CREATE_EVALUATION_QUESTION_EVENTSCORECARDS_UPDATE_EVALUATION_QUESTION_EVENTSCORECARDS_DELETE_EVALUATION_QUESTION_EVENTSCORECARDS_CREATE_SCORECARD_QUESTION_EVENTSCORECARDS_UPDATE_SCORECARD_QUESTION_EVENTSCORECARDS_DELETE_SCORECARD_QUESTION_EVENTSCORECARDS_CREATE_AUTO_EVALUATION_EVENTSCORECARDS_UPDATE_EVALUATION_EVENTSCORECARDS_CREATE_SMART_EVALUATION_EVENTTICKET_CREATE_EVENTTICKET_EDIT_EVENTTICKET_CLOSE_EVENTTICKET_ACTION_CREATE_EVENTTICKET_ACTION_EDIT_EVENTTICKET_ACTION_STATE_CHANGE_EVENTTICKET_PARTICIPANT_EVENTTICKET_CREATE_COMMENT_EVENTTICKET_REPLY_COMMENT_EVENTTICKET_TEMPLATE_CREATE_EVENTTICKET_TEMPLATE_EDIT_EVENTTICKET_TEMPLATE_CLOSE_EVENTTICKET_TEMPLATE_ASSIGN_EVENTTICKET_TEMPLATE_STATE_CHANGE_EVENTTICKET_PROJECT_STATE_CHANGE_EVENTTICKET_CONTACT_ADD_EVENTTICKET_CUSTOM_FIELD_CREATE_EVENTTICKET_CUSTOM_FIELD_EDIT_EVENTCOMPLIANCE_RND_QUERY_EVENTCOMPLIANCE_RND_QUERY_CACHED_EVENTAGENT_TRAINING_CREATE_LEARNING_OPPORTUNITY_EVENTLMS_PIPELINE_FAILURE_EVENTLMS_PIPELINE_NO_OUTPUT_EVENTLMS_PIPELINE_SUCCESSFUL_EVENTEVENT_TYPE_BILLING_COMMIT_BILLING_PLANEVENT_TYPE_BILLING_CREATE_BILLING_PLANEVENT_TYPE_BILLING_CREATE_INVOICEEVENT_TYPE_BILLING_CREATE_RATE_DEFINITIONEVENT_TYPE_BILLING_DELETE_BILLING_PLANEVENT_TYPE_BILLING_DELETE_INVOICEEVENT_TYPE_BILLING_DELETE_RATE_DEFINITIONEVENT_TYPE_BILLING_EXPORT_INVOICEEVENT_TYPE_BILLING_UPDATE_BILLING_PLANEVENT_TYPE_BILLING_UPDATE_INVOICEEVENT_TYPE_BILLING_UPDATE_RATE_DEFINITIONEVENT_TYPE_BILLING_RATED_ITEMS_GENERATEDEVENT_TYPE_BILLING_ACCUMULATE_ITEMSEVENT_TYPE_DELIVERY_FAILUREEVENT_TYPE_DELIVERY_SUCCESSEVENT_TYPE_CONTACT_MANAGER_ADD_EVENTEVENT_TYPE_CONTACT_MANAGER_ENTRY_VIEW_EVENTEVENT_TYPE_CONTACT_MANAGER_KYC_ENC_VIEW_EVENTEVENT_TYPE_CONTACT_MANAGER_TTL_EVENTEVENT_TYPE_CONTACT_MANAGER_EDIT_EVENTEVENT_TYPE_CONTACT_MANAGER_UPLOAD_EVENTEVENT_TYPE_CONTACT_MANAGER_VERIFICATION_EVENTEVENT_TYPE_CONTACT_MANAGER_DELETE_EVENTEVENT_TYPE_CONTACT_MANAGER_EXPUNGE_EVENTEVENT_TYPE_CONTACT_MANAGER_ENTITY_ASSOCIATED_EVENTEVENT_TYPE_ORGANIZATION_ACCESS_TOKENS_EXPIRING_EVENTEVENT_TYPE_WFM_PUBLISH_SCHEDULE_EVENTEVENT_TYPE_P3_AMQP_CALL_RESULT_EVENTEVENT_TYPE_P3_AMQP_AGENT_RESPONSE_EVENT

org_id

string

org_id

optional

Required.

Example

{
    "event_type": "DUMMY_APPLICATION",
    "org_id": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response for listing subscriptions for multiple users.

subscriptions

array[null (UserSubscription) {2}]

subscriptions

optional

object

delivery

optional

object

room303

optional

Example

{
    "subscriptions": [
        {
            "delivery": {
                "transfer_config_name": "string"
            }
        }
    ]
}

🔴500Server Error