GET v1/events/{eventId}/participants?userId={userId}&name={name}&status={status}&dateRangeBegin={dateRangeBegin}&dateRangeEnd={dateRangeEnd}&attended={attended}&pageSize={pageSize}&page={page}

Returns a list of participants for an event

Request Information

URI Parameters

Name	Description	Type	Additional information
eventId	Id for event	integer	Required
userId	Return only participants matching this userId	integer
name	Search by participant name	string
status	Return registrations matching this status (WaitingApproval, Approved, Cancelled, Draft, Declined)	string
dateRangeBegin	Return only participants who registered after this date	date
dateRangeEnd	Return only participants who registered before this date	date
attended	Set to true to pull only participants who attended opportunity. Set to false to pull only participants who did not attend. Leave null for all participants (default)	boolean
pageSize	Number of results to return (defaults to 25, max of 200)	integer	Default value is 25
page	Page number (starting page is 1)	integer	Default value is 1

Body Parameters

None.

Sample Request

https://api.servicereef.com/v1/events/{eventId}/participants?userId={userId}&name={name}&status={status}&dateRangeBegin={dateRangeBegin}&dateRangeEnd={dateRangeEnd}&attended={attended}&pageSize={pageSize}&page={page}

Response Information

Resource Description

ParticipantsResult

Name	Description	Type	Additional information
PageInfo		PageModel
Results		Collection of ParticipantModel

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample:

{
  "PageInfo": {
    "TotalRecords": 1,
    "Page": 2,
    "PageSize": 3
  },
  "Results": [
    null,
    {
      "MasterApplicationAnswers": [
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        },
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        }
      ],
      "ApplicationAnswers": [
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        },
        {
          "QuestionId": 1,
          "Question": "sample string 2",
          "HelpText": "sample string 3",
          "Answer": "sample string 4",
          "QuestionType": "Unknown"
        }
      ],
      "BackgroundCheckDate": "2024-12-22T18:38:10.045389Z",
      "ParticipantFundraisingGoal": 1.0,
      "AmountRaised": 2.0,
      "BalanceDue": -1.0,
      "FundraisingPageUrl": "sample string 3",
      "Tags": [
        {
          "CategoryId": 1,
          "Name": "sample string 2",
          "Options": [
            {
              "CategoryOptionId": 1,
              "Name": "sample string 2"
            },
            {
              "CategoryOptionId": 1,
              "Name": "sample string 2"
            }
          ]
        },
        {
          "CategoryId": 1,
          "Name": "sample string 2",
          "Options": [
            {
              "CategoryOptionId": 1,
              "Name": "sample string 2"
            },
            {
              "CategoryOptionId": 1,
              "Name": "sample string 2"
            }
          ]
        }
      ],
      "RegistrationStatus": "sample string 6",
      "DateRegistered": "2024-12-22T18:38:10.045389Z",
      "Attended": true,
      "RegisteredForAllTimeSlots": true,
      "TimeSlots": [
        {
          "SlotDate": "2024-12-22T18:38:10.045389Z",
          "StartTime": "2024-12-22T18:38:10.045389Z",
          "EndTime": "2024-12-22T18:38:10.045389Z",
          "DateRegistered": "2024-12-22T18:38:10.045389Z",
          "Attended": true
        },
        {
          "SlotDate": "2024-12-22T18:38:10.045389Z",
          "StartTime": "2024-12-22T18:38:10.045389Z",
          "EndTime": "2024-12-22T18:38:10.045389Z",
          "DateRegistered": "2024-12-22T18:38:10.045389Z",
          "Attended": true
        }
      ],
      "UserId": 8,
      "FirstName": "sample string 9",
      "LastName": "sample string 10",
      "Email": "sample string 11",
      "Phone": "sample string 12",
      "Address": {
        "Latitude": 1.1,
        "Longitude": 1.1,
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "Zip": "sample string 5",
        "Country": "sample string 6",
        "Name": "sample string 7"
      },
      "ProfileUrl": "https://app.servicereef.com/users/sample string 15",
      "PassportStatus": "sample string 16",
      "FirstNameOnPassport": "sample string 17",
      "MiddleNameOnPassport": "sample string 18",
      "LastNameOnPassport": "sample string 19",
      "FullNameOnPassport": "sample string 17 sample string 18 sample string 19",
      "PassportSex": "sample string 20",
      "PassportPlaceOfBirth": "sample string 21",
      "PassportDateOfBirth": "2024-12-22T18:38:10.045389Z",
      "PassportNumber": null,
      "PassportIssued": null,
      "PassportIssuedBy": null,
      "PassportExpirationDate": null,
      "PassportImageUrl": null,
      "Households": null,
      "Interests": null
    }
  ]
}

Back GET v1/events/{eventId}/participants