NGngpvan

/voterRegistrationBatches

Changed on

Search for voter registration batches, with required filtering.

get/voterRegistrationBatches

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/voterRegistrationBatches
  • Auth
    HTTP basic

Query parameters

createdBeforestring date

Filters batches created before a given date (in the format yyyy-MM-dd)

createdAfterstring date

Filters batches created after a given date (in the format yyyy-MM-dd)

statusstring

Filters batches by batch status

stateCodestring

Filters batches by state. Must be a valid two letter US state abbreviation.

onlyMyBatchesboolean

Filters batches created by the API key

programTypeIdinteger
namestring

Filters batches by program type

personTypestring

Filters batches by person type

$orderbystring

Optional; sorts results in ascending (asc) or descending (desc) order by a comma-delimited list of properties: DateCreated, StateCode, Name. Note that a space is required between the property and asc or desc.

$topinteger
$skipinteger

Response

200

nextPageLinkstring
countinteger

Example response

{
  "items": [
    {
      "voterRegistrationBatchId": 100,
      "name": "VR Batch",
      "description": "VR Batch Description",
      "stateCode": "MA",
      "form": {
        "formId": 101,
        "name": "VR Form"
      },
      "status": "Entering",
      "programType": {
        "programTypeId": 201,
        "name": "VR Program"
      },
      "personType": "Applicant",
      "dateCreated": "2019-08-01T00:00:00Z"
    }
  ],
  "nextPageLink": "https://api.securevan.com/v4/voterRegistrationBatches?StateCode=MA&$orderby=DateCreated desc&$top=1&$skip=1",
  "count": 25
}

Changes