GET /api/v2/subscriptions/fax

Gets a list of all the fax event subscriptions of a company or of a target.

Added on Jan 12th, 2024 for API v2.

Requires scope: fax_message

Rate limit: 1200 per minute.

Servers

Query parameters

Name Type Required Description
cursor String No

A token used to return the next page of a previous request. Use the cursor provided in the previous response.

target_id Integer No

The target's id.

target_type String No

The target's type.

Valid values:

  • "room"
  • "callrouter"
  • "channel"
  • "coachingteam"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.