Skip to content

GET Registrations Query Parameters

Adam Meyer edited this page Mar 17, 2015 · 11 revisions

GET /conferences/:conference_id/registrations If a parameter is not specified, the default will be used.

block: id of block to include in registration answers. (more than one can be sent)

page: current page (1 being first) (default: 1)

limit: registrations per page (default: 20)

orderBy: Column to sort registrations by.

  • first_name
  • last_name (default)
  • email
  • created_timestamp
  • completed_timestamp
  • checked_in_timestamp
  • withdrawn_timestamp
  • paid (totalPaid = calculatedTotalDue)
  • (any block id)

order:

  • ASC (default)
  • DESC

filter: string to filter registrations based on answer (can match any block answer)

filterPayment:

  • any (default)
  • full (includes overpaid)
  • partial (greater than 0, less than amount due)
  • full-partial (any greater than 0)
  • none (amount paid is 0)
  • over (amout paid is greater than total due)

filterRegType: reg type id to filter registrations by

includeCheckedin:

  • yes (default)
  • no
  • only

includeWithdrawn:

  • yes (default)
  • no
  • only

includeIncomplete:

  • yes
  • no (default)
  • only

Meta data

The returned body also needs to include meta data

{
"registrations": [],
"meta": {
"totalRegistrants": 200,
"totalRegistrantsFilter": 100,
"currentPage": 1,
"totalPages": 5
}
}
Clone this wiki locally