Skip to main content

GetRequestsResponse

result object
elements object[]
  • Array [
    • requestidrequestId (string)

    ID of the erasure request

    Example: OP-1234-5678-9101
    statusstatus (string)

    The status of the erasure request.

    Possible values: [Pending, In Progress, Complete, Failed, Completed Search]

    Example: In Progress
    userUser (string)

    The userid of the user who requested the erasures.

    Example: example@qualtrics.com
    numEmailsRequestedinteger<int64>

    The number of emails for which erasure is requested

    Example: 10
    emailsNotFoundEmail (string)[]

    The number of emails requested but not found.

    Example: ["test1@qualtrics.com","test2@qualtrics.com"]
    emailListemail (string)[]

    The list of emails requested to be be erased.

    Example: ["test1@qualtrics.com","test2@qualtrics.com"]
    searchOnlysearchOnly. this should be fixed to boolean to be consistent with request (string)

    Indicates whether this was a dry run or not. If true, then no emails were erased.

    failureReasonfailure reason (string)

    If the status is failuer, the reason for the failure will be here.

    createdstring<date-time>

    The date and time the erasure request was created.

    Example: 2018-04-01T09:00:00Z
    updatedstring<date-time>

    The date and time when the erasure request was last updated.

    Example: 2018-04-01T09:00:00Z
  • ]
    • nextPagenextPage (string)nullable
    Example: https://{$env}.qualtrics.com/API/v3/erasure-requests?id=OP-123&created=2019-02-27T18:50:33Z
    meta object
    httpStatusHttp status code (string)required
    requestIdrequestId (string)required
    noticeAn informational string about the request. (string)
    GetRequestsResponse
    {
      "result": {
        "elements": [
          {
            "requestid": "OP-1234-5678-9101",
            "status": "In Progress",
            "user": "example@qualtrics.com",
            "numEmailsRequested": 10,
            "emailsNotFound": [
              "test1@qualtrics.com",
              "test2@qualtrics.com"
            ],
            "emailList": [
              "test1@qualtrics.com",
              "test2@qualtrics.com"
            ],
            "searchOnly": "string",
            "failureReason": "string",
            "created": "2018-04-01T09:00:00Z",
            "updated": "2018-04-01T09:00:00Z"
          }
        ],
        "nextPage": "https://{$env}.qualtrics.com/API/v3/erasure-requests?id=OP-123&created=2019-02-27T18:50:33Z"
      },
      "meta": {
        "httpStatus": "string",
        "requestId": "string",
        "notice": "string"
      }
    }