Skip to main content
POST
/
consent
/
{consentFormId}
/
submissions
/
search
Search submissions for a consent form
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 '
{
  "filter": {
    "filters": [
      {
        "customProperty": {
          "propertyType": "STRING",
          "propertyGroup": "CUSTOM_PROPERTY",
          "propertyName": "CUSTOM_PROPERTY",
          "propertyId": "custom_property_1",
          "operator": "IS",
          "value": "some value"
        }
      }
    ],
    "operator": "AND",
    "sort": {
      "operator": "ASC",
      "propertyGroup": "PERSON",
      "propertyName": "PERSON_ID"
    }
  },
  "studyId": "<string>",
  "pageInfo": {
    "size": 10
  }
}
'
{
  "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

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.

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

Example:
{ "size": 10 }

Response

The consent form submissions

results
object[]
required
total
number
required

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

pageInfo
object
required

Information about the current page