Search submissions for a consent form

Search submissions for a specific consent form. Returns submission data including person ID, submission source, and submission date.

POST /consent/{consentFormId}/submissions/search

Search submissions for a consent form

cURL

curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/consent/{consentFormId}/submissions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "studyId": "<string>",
  "pageInfo": {
    "size": 10
  }
}
'

200

{
  "results": [
    {
      "submissionId": "<string>",
      "consentFormId": "<string>",
      "personId": "<string>",
      "email": "<string>",
      "submissionSource": "SCHEDULER",
      "submittedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consentFormId · string · required

The ID of the consent form

Body

application/json

filter · object

Filter options to search consent form submissions. Supports person, incentive, and participant property filters.

Show child attributes

studyId · string

Study ID for participant property filters (required when filtering by participant).

pageInfo · object

Pagination arguments. Use startCursor from the result of the endCursor of the response to get the next page. Pagination in reverse is not currently supported

Show child attributes

Example:

{ "size": 10 }

Response

200

application/json

The consent form submissions

results · object[] · required

Show child attributes

total · number · required

The total number of items in your workspaces based on your search parameters

pageInfo · object · required

Information about the current page

Show child attributes