NGngpvan

/voterRegistrationBatches/states/{state}/supportedFields

Changed on

Retrieve list of fields available for use when sending registrants via POST /voterRegistrationBatches/{batchId}/people. Though the fields themselves are not currently state-specific, the possible values for dropdown fields are state-specific.

State must be a valid US state abbreviation.

get/voterRegistrationBatches/state/{state}/supportedFields

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/voterRegistrationBatches/state/{state}/supportedFields
  • Auth
    HTTP basic

Path parameters

statestring required

The US state of the batch. Must be a valid two letter US state abbreviation.

Response

200

nextPageLinkunknown
countinteger

Example response

{
  "items": [
    {
      "customPropertyKey": "VR:CatBreed",
      "displayName": "Cat Breed",
      "fieldType": "Dropdown",
      "possibleValues": [
        {
          "key": "A",
          "value": "American Shorthair"
        }
      ]
    }
  ],
  "count": 2
}

Changes