Get activities

Returns the paginated history of contact voice authentication activities for the account, such as authentication attempts and other identity-related events captured during calls.
Use this endpoint to power dashboards, audit views or reporting flows that need a chronological feed of identity activity for contacts in the account.

The list is paginated and the maximum page size is 250 items, so larger exports must use the CSV-producing variant of this endpoint instead.
When the contact query parameter is true (the default), activity entries are enriched with the matching contact's name and id resolved from the phone number; setting it to false skips that lookup and returns the raw activity records.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

identity-activity:read

Query Params
boolean
Defaults to true

Populate contact name and id, from contacts API, based on the phone number.

string
length ≤ 1600

Allows filtering by using comparison and logical operators.


  • To search parts of a string within a field of type string then the contains operator should be used.

    The syntax is the following: contains(field, 'value')



  • Logical operators are and and or.

    When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.

    (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).


    Examples:

    • (contains(user_id, 'agent1') or contains(user_id, 'agent2')) and active eq true

    • contains(user_id, 'agent1')

    • (login_timestamp ge '2020-12-18T13:09:09.417Z' and login_timestamp le '2020-12-18T13:09:09.417Z')


    More information here

    string
    length ≤ 40
    Defaults to timestamp:desc

    The list of fields to sort by.

    integer
    ≥ 1
    Defaults to 1

    Number of the requested page

    integer
    1 to 250
    Defaults to 5

    Max number of the items in a page

    Responses

    Language
    Credentials
    OAuth2
    Missing 1 required scope
    URL
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json