Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    List GDPR requests

    Retrieves a list of GDPR requests of all types.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/privacy/gdpr
    

    Parameters

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    token

    string

    Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set as 0.

    limit

    int

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

    ?token=ZkQ4RDaSTl1AlE1WXlVbF2Y2&limit=5
    

    Response

    If successful, this action returns a list of GDPR requests of all types in the response body.

    {
        "requests": [
            {
                "request_id": "944a3469aa5j831",
                "action": "delete",
                "status": "scheduled",
                "user_ids": ["Jacob", "Glen", "John"],
                "channel_delete_option": "do_not_delete",
                "created_at": 1565343241000
            },
            {
                "request_id": "55b49a317d18480",
                "action": "delete",
                "status": "done",
                "user_ids": ["Alek", "Andi"],
                "channel_delete_option": "all",
                "files": {
                    "url": "",
                    "expires_at": 0
                },
                "created_at": 1565169737000
            },
            {
                "request_id": "4832ba69aa482d9",
                "action": "access",
                "status": "scheduled",
                "user_id": "Mickey",
                "created_at": 1565167921000
            },
            {
                "request_id": "66e7c52292984ff",
                "action": "access",
                "status": "done",
                "user_id": "Jeff",
                "files": {   # The 'files' appears only when the status is 'done'.
                    "url": "https://sendbird-us-1.s3-us-west-2.amazonaws.com/36e7c52292d32ef.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b84c5aa3a7fecac360dceed6eb91c549733f38c72eff899825edd2d64b4bb42b&X-Amz-Date=20190807T093010Z&X-Amz-Credential=AKIAISCYADSMJDK2PZCA%2F20190807%2Fus-west-2%2Fs3%2Faws4_request",
                    "expires_at": 1565775010191     # 7 days from the timestamp of file creation.
                },
                "created_at": 1565169776000
            },
            ...
        ],
        "next": "XZYZ2AVnQVErEUBXWFNeF25dFkFZVA~~"
    }
    

    List of response properties

    Property nameTypeDescription

    requests[]

    array of objects

    An array of GDPR requests.

    (requests).request_id

    string

    The unique ID for the GDPR request.

    (requests).action

    string

    The type of the GDPR request.

    (requests).status

    string

    The current status of the GDPR request. Valid values are the following:
    - scheduled: the request is scheduled to process.
    - processing: the request is being processed.
    - done: the request has been completed.
    - no_data: there is no corresponding data because the user was already deleted or there was an issue with the server.

    (requests).user_ids[]

    array of strings

    The IDs of the users to be deleted or deleted to comply with the GDPR's requirements. This is effective only when the value of the action property is set to delete.

    (requests).user_id

    string

    The ID of the user whose user data is to be generated or generated to comply with the GDPR's requirements. This is effective only when the value of the action property is set to access.

    (requests).files

    nested object

    Information about the zip file created from the GDPR request. This object has the following two properties:
    - url: the URL of the zip file containing the result file and directories for downloading. The zip file is named in <user_name>.json format and the directory names are channels and messages.
    - expires_at: the time at which the zip file expires. This indicates that the file will be valid for 7 days starting from the time of file creation.

    (requests).created_at

    long

    The time at which a request was created in Unix milliseconds format.

    next

    string

    The value of the token parameter to retrieve the next page in the result.

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