NGngpvan

/activistCodes

Changed on

Use this endpoint to retrieve all Activist Codes that are available in the current context.

This endpoint accepts standard pagination parameters and returns a standard paginated response.

By default, this endpoint returns 50 records per request. A maximum of 200 records per request is allowed via the $top parameter.

get/activistCodes

Request

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

Query parameters

statusesstring

Comma-delimited list of statuses of Activist Codes. One or more of Active (default), Archived, and Inactive.

namestring

Filters to Activist Codes with names that start with the given input

typestring

Filters to Activist Codes of the given type

$topinteger

Response

200

nextPageLinkunknown
countinteger

Example response

{
  "items": [
    {
      "activistCodeId": 3214,
      "type": "Volunteer",
      "name": "Precinct Captain",
      "mediumName": "P Capt",
      "shortName": "PC",
      "description": "Precinct Captain",
      "scriptQuestion": "Would you be willing to be a Precinct Captain?",
      "status": "Active"
    }
  ],
  "count": 1
}

Changes