NGngpvan

/signups/{eventSignupId}

Changed on

Use this endpoint to retrieve a specific Event Signup.

This endpoint returns a standard Signup object, if found.

If the specified Signup does not exist, this endpoint will return an error with HTTP Status Code 404 Not Found.

get/signups/{eventSignupId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/signups/{eventSignupId}
  • Auth
    HTTP basic

Path parameters

eventSignupIdinteger required

Required; Unique identifier of an existing event shift

Query parameters

IncludePhoneAndEmailstring

True / False; By default, phone and email data is not returned.

Response

200

eventSignupIdinteger
startTimeOverridestring
endTimeOverridestring

Example response

{
  "eventSignupId": 2452,
  "person": {
    "vanId": 100476252,
    "firstName": "James",
    "middleName": "Worthington",
    "lastName": "Gordon"
  },
  "event": {
    "eventId": 1370,
    "name": "Neighbors Calling Neighbors",
    "shortName": "NeighborCall"
  },
  "shift": {
    "eventShiftId": 2162
  },
  "role": {
    "roleId": 111687,
    "name": "Host"
  },
  "status": {
    "statusId": 4,
    "name": "Invited"
  },
  "location": {
    "locationId": 272,
    "name": "Campaign HQ",
    "displayName": "Campaign HQ, 48 Grove St Somerville, MA 02144-2500"
  },
  "startTimeOverride": "2015-06-01T15:00:00-04:00",
  "endTimeOverride": "2015-06-01T16:00:00-04:00"
}

Changes