Skip to main content
POST
/
signups
/
{signupFormId}
/
submissions
/
search
Search submissions for a signup form
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/signups/{signupFormId}/submissions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "studyId": "<string>",
  "pageInfo": {
    "size": 10
  }
}
'
{
  "results": [
    {
      "submissionId": "<string>",
      "signupFormId": "<string>",
      "personId": "<string>",
      "submittedAt": "2023-11-07T05:31:56Z",
      "consentSubmissionId": "<string>"
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rallyuxr.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
signupFormId
string
required

The ID of the signup form

Body

application/json
​
filter
object

Filter options to search signup 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 signup 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