/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    List audit logs

    Copy link

    Retrieves a list of audit logs.


    HTTP request

    Copy link
    GET https://gate.sendbird.com/api/v2/audit_logs
    

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    limit

    int

    Specifies the number of results to retrieve per page. Acceptable values are 1 to 500, inclusive. (Default: 100)

    offset

    int

    Specifies the number of results to skip before retrieving the next page in the result page. This is used to adjust the starting index of the next page. (Default: 0)

    date

    string

    Specifies the date filter for retrieving results. Only results on the specified date will be included. The date must be later than 2025-08-01 and formatted as YYYY-MM-DD. An example can be 2025-08-15.

    ?limit=100&offset=0&date=2025-10-31
    

    Response

    Copy link

    If successful, this action returns a list of applications in the response body.

    {
        "count": 123,
        "next": "https://gate.sendbird.com/api/v2/audit_logs?date=2025-10-31&limit=100&offset=200",
        "previous": "https://gate.sendbird.com/api/v2/audit_logs?date=2025-10-31&limit=100",
        "results": [
            {
                "log_id": "xxxxxx-xxxx-xx-xxxx-xxxxxx",
                "method": "POST",
                "path": "/api/path/",
                "request_size": 2,
                "data": "{}",
                "status_code": 200,
                "response_size": 0,
                "auth_type": null,
                "organization_uid": "xxxxxxxxxxxxxxxxxxxx",
                "app_id": "",
                "gate_user_pk": 123123123,
                "gate_user_role": "OWNER",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.0.0 Safari/537.36",
                "user_ip": "1.23.45.678",
                "time_millis": "2025-10-10T13:01:53.541000+00:00",
                "timestamp": "2025-10-10T13:01:53.360000+00:00",
                "updated_dt": "2025-10-10T13:01:57.730000+00:00",
                "team_account_id": null
            },
          ... # more audit logs
      ],
    }
    

    List of response properties

    Copy link
    Property nameTypeDescription

    count

    int

    The total count of audit_logs of the date in an organization.

    previous

    string

    The URL to retrieve the previous page in a result set.

    next

    string

    The URL to retrieve the next page in a result set.

    results[]

    array of objects

    An array of applications.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.