For AI agents: visit https://docs.everyaction.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
EveryActionEveryAction
GuidesRecipesAPI ReferenceChangelog
EveryAction
API Reference
GuidesRecipesAPI ReferenceChangelog

EveryAction 8

  • Overview
    • Request Data
    • Authentication
    • Data Model
    • Security model
    • API Key Expirations
    • Errors
    • Input Validation
    • Expansion
    • Pagination
    • JSON Patch
    • Endpoints
    • Public users
    • Introspectionget
    • /echoespost
  • People
    • Overview
    • Common Models
    • /peopleget
    • /people/findpost
    • /people/findByPhonepost
    • /people/findOrCreatepost
    • /people/{vanId}post
    • /people/{personIdType}:{personId}post
    • /people/{vanId}/mergeIntoput
    • /people/{vanId}del
    • /people/{vanId}get
    • /people/{personIdType}:{personId}get
    • /people/{vanId}/canvassResponsespost
    • /people/{personIdType}:{personId}/canvassResponsespost
    • /people/{vanId}/canvassResponses/{referenceId}get
    • /people/{personIdType}:{personId}/canvassResponses/{referenceId}get
    • /people/{vanId}/canvassResponses/{canvassResponseId}patch
    • /people/{personIdType}:{personId}/canvassResponses/{canvassResponseId}patch
    • /people/{vanId}/activistCodesget
    • /people/{vanId}/codespost
    • /people/{personIdType}:{personId}/codespost
    • /people/{vanId}/disclosureFieldValuespost
    • /people/{personIdType}:{personId}/disclosureFieldValuespost
    • /people/{vanId}/relationshipspost
    • /people/{vanId}/notesget
    • /people/{vanId}/notespost
    • /people/{personIdType}:{personId}/notespost
    • /people/{vanId}/notes/{noteId}put
    • /people/{vanId}/codes/{codeId}del
    • /people/{personIdType}:{personId}/codes/{codeId}del
    • /people/{vanId}/myActivistFlagsput
    • /people/{vanId}/myActivistFlagsdel
    • /people/{vanId}/membershipget
    • /people/{vanId}/namespatch
  • Activist Codes
    • Overview
    • Common Models
    • /activistCodesget
    • /activistCodes/{activistCodeId}get
  • Ballots
    • Common Models
    • /ballotReturnStatusesget
    • /ballotReturnStatuses/{ballotReturnStatusId}get
    • /ballotRequestTypesget
    • /ballotRequestTypes/{ballotRequestTypeId}get
    • /ballotTypesget
    • /ballotTypes/{ballotTypeId}get
  • Bargaining Units
    • Overview
    • Common Models
    • /bargainingUnitsget
    • /bargainingUnits/{bargainingUnitId}get
    • /bargainingUnitspost
  • Bulk Import
    • Overview
    • Conceptual Introduction
    • Workflow
    • Common models
    • /bulkImportJobs/{jobId}get
    • /bulkImportJobs/resourcesget
    • /bulkImportMappingTypesget
    • /bulkImportMappingTypes/{mappingTypeName}get
    • /bulkImportMappingTypes/{mappingTypeName}/{fieldName}/valuesget
    • /bulkImportJobspost
  • Campaigns
    • Overview
    • Common Models
    • /campaignsget
    • /campaigns/{campaignId}get
  • Canvass File Requests
    • Overview
    • /canvassFileRequestspost
    • /canvassFileRequests/{canvassFileRequestId}get
  • Canvass Responses
    • Overview
    • /canvassResponses/contactTypesget
    • /canvassResponses/inputTypesget
    • /canvassResponses/resultCodesget
  • Changed Entities
    • Overview
    • Common Models
    • /changedEntityExportJobs/resourcesget
    • /changedEntityExportJobs/changeTypes/{resourceType}get
    • /changedEntityExportJobs/fields/{resourceType}get
    • /changedEntityExportJobspost
    • /changedEntityExportJobs/{exportJobId}get
  • Codes
    • Overview
    • Common Models
    • /codesget
    • /codes/{codeId}get
    • /codespost
    • /codes/batchpost
    • /codes/{codeId}patch
    • /codesput
    • /codes/{codeId}put
    • /codesdel
    • /codes/{codeId}del
    • /codes/supportedEntitiesget
    • /codeTypesget
  • Commitments
    • Overview
    • Common Models
    • /commitmentspost
    • /commitments/{commitmentId}patch
    • /commitments/recurringPaymentspost
  • Contributions
    • Overview
    • Common models
    • /contributionspost
    • /contributions/{contributionId}get
    • /contributions/{alternateIdType}:{alternateId}get
    • /contributions/attributionTypesget
    • /contributions/{contributionId}/attributions/{vanId}put
    • /contributions/{contributionId}/attributions/{vanId}del
    • /contributions/{contributionId}/adjustmentspost
    • /contributions/paymentspost
    • /contributions/recentContributionsget
  • Custom Fields
    • Overview
    • Common models
    • /customFieldsget
    • /customFields/{customFieldId}get
  • Departments
    • Overview
    • Common Models
    • /departmentsget
    • /departments/{departmentId}get
  • Designations
    • Overview
    • Common Models
    • /designationsget
    • /designations/{designationId}get
  • Disbursements
    • Overview
    • Common models
    • /disbursementspost
    • /disbursements/{disbursementId}get
    • /disbursements/recentDisbursementsget
  • District Fields
    • Overview
    • Common models
    • /districtFieldsget
    • /districtFields/{districtFieldId}get
  • Early Vote Fields
    • Overview
    • Common Models
    • /earlyVoteFieldsget
    • /earlyVoteFields/{earlyVoteFieldId}get
  • Email
    • Overview
    • Common models
    • /email/messagesget
    • /email/message/{emailId}get
  • Employers
    • Overview
    • Common Models
    • /employersget
    • /employers/{employerId}get
    • /employers/{employerId}patch
    • /employerspost
    • /employers/{employerId}/bargainingUnits/{bargainingUnitId}post
    • /employers/{employerId}/bargainingUnits/{bargainingUnitId}del
    • /employers/{employerId}/bargainingUnits/{bargainingUnitId}/jobClasses/{jobClassId}post
    • /employers/{employerId}/bargainingUnits/{bargainingUnitId}/jobClasses/{jobClassId}del
    • /employers/{employerId}/departmentspost
    • /employers/{employerId}/shiftTypes/{shiftTypeId}post
    • /employers/{employerId}/shiftTypes/{shiftTypeId}del
    • /employers/{employerId}/worksitespost
  • Event Types
    • Overview
    • Common models
    • /events/typesget
    • /events/types/{eventTypeId}get
  • Events
    • Overview
    • Common models
    • /eventsget
    • /events/{eventId}get
    • /events/{eventId}patch
    • /eventspost
    • /events/{eventId}/shiftspost
    • /events/{eventId}put
    • /events/{eventId}del
  • Export Jobs
    • Overview
    • Common Models
    • /exportJobTypesget
    • /exportJobspost
    • /exportJobs/{exportJobId}get
  • Extended Source Codes
    • Overview
    • Common models
    • /codes/extendedSourceCodesget
  • File-Loading Jobs
    • Overview
    • /fileLoadingJobspost
    • /fileLoadingJobs/{jobId}get
    • /fileLoadingJobs/{jobId}/statsget
  • Financial Batches
    • Overview
    • Common models
    • /financialBatchesget
    • /financialBatches/{financialBatchId}get
    • /financialBatchespost
  • Folders
    • Overview
    • Common Models
    • /foldersget
    • /folders/{folderId}get
    • /folders/{folderId}/mapRegionsget
    • /folders/{folderId}/mapRegions/refreshpost
    • /folders/{folderId}/mapRegions/{mapRegionId}get
    • /folders/{folderId}/mapRegions/{mapRegionId}/refreshpost
  • Job Classes
    • Overview
    • Common models
    • /jobClassesget
    • /jobClasses/{jobClassId}get
    • /jobClassespost
  • Locations
    • Overview
    • Common models
    • /locationsget
    • /locations/{locationId}get
    • /locations/findOrCreatepost
    • /locationspost
    • /locations/{locationId}del
  • Member Statuses
    • Overview
    • Common models
    • /memberStatusesget
    • /memberStatuses/{memberStatusId}get
    • /memberStatusespost
  • MiniVAN Exports
    • Overview
    • Common models
    • /minivanExportsget
    • /minivanExports/{minivanExportId}get
  • Notes
    • Overview
    • Common Models
    • /notes/categoryTypesget
    • /notes/categoriesget
    • /notes/categories/{noteCategoryId}get
  • Online Actions Forms
    • Overview
    • Common Models
    • /onlineActionsFormsget
    • /onlineActionsForms/{formTrackingId}get
  • Printed Lists
    • Overview
    • Common Models
    • /printedListsget
    • /printedLists/{printedListNumber}get
  • Relationships
    • Overview
    • /relationshipsget
  • Reported Demographics
    • Overview
    • /reportedRacesget
    • /reportedEthnicitiesget
    • /reportedLanguagePreferencesget
    • /reportedSexualOrientationsget
    • /reportedGendersget
    • /pronounsget
  • Saved Lists
    • Overview
    • Common Models
    • /savedListsget
    • /savedLists/{savedListId}get
    • /savedLists/smsSyncpost
  • Schedule Types
    • Overview
    • Common Models
    • /scheduleTypesget
    • /scheduleTypes/{scheduleTypeId}get
    • /scheduleTypespost
  • Score Updates
    • Overview
    • /scoreUpdatesget
    • /scoreUpdates/{scoreUpdateId}get
    • /scoreUpdates/{scoreUpdateId}patch
  • Scores
    • Overview
    • /scoresget
    • /scores/{scoreId}get
    • /scores/{scoreId}/committeeAccessget
  • Shift Types
    • Overview
    • Common Models
    • /shiftTypesget
    • /shiftTypes/{shiftTypeId}get
    • /shiftTypespost
  • Signups
    • Overview
    • Common Models
    • /signups/statusesget
    • /signups/{eventSignupId}get
    • /signupsget
    • /signupspost
    • /signups/{eventSignupId}put
    • /signups/{eventSignupId}del
  • Stories
    • Overview
    • Common Models
    • /stories/{storyId}get
    • /storiespost
  • Supporter Groups
    • Overview
    • Common Models
    • /supporterGroupsget
    • /supporterGroupspost
    • /supporterGroups/{supporterGroupId}del
    • /supporterGroups/{supporterGroupId}get
    • /supporterGroups/{supporterGroupId}/people/{vanId}put
    • /supporterGroups/{supporterGroupId}/people/{vanId}del
  • Survey Questions
    • Overview
    • Common Models
    • /surveyQuestionsget
    • /surveyQuestions/{surveyQuestionId}get
    • /surveyQuestionspost
    • /surveyQuestions/{surveyQuestionId}put
  • Target Export Jobs
    • Overview
    • /targetExportJobspost
    • /targetExportJobs/{exportJobId}get
  • Targets
    • Overview
    • Common Models
    • /targetsget
    • /targets/{targetId}get
  • Users
    • Overview
    • Common Models
    • /users/{userId}/districtFieldValuesget
    • /users/{userId}/districtFieldValuespost
    • /users/{userId}/districtFieldValuesput
  • Voter Registration Batches
    • Overview
    • Common Models
    • /voterRegistrationBatchesget
    • /voterRegistrationBatches/programTypesget
    • /voterRegistrationBatches/registrationFormsget
    • /voterRegistrationBatches/state/{state}/supportedFieldsget
    • /voterRegistrationBatchespost
    • /voterRegistrationBatches/{batchId}patch
    • /voterRegistrationBatches/{batchId}/peoplepost
  • Worksites
    • Overview
    • Common Models
    • /worksitesget
    • /worksites/{worksiteId}get
    • /worksites/{worksiteId}put
    • /worksites/{worksiteId}del
    • /worksites/{worksiteId}/workAreaspost
    • /worksites/{worksiteId}/workAreas/{workAreaId}put
    • /worksites/{worksiteId}/workAreas/{workAreaId}del

ActionTag

  • Overview
  • Form Embedding
    • How to find Embed Code
    • Notes for website builder products
  • Attributes
    • data-form-url (required)
    • data-id (legacy implementations)
    • data-endpoint
    • data-formdef-endpoint
    • data-labels
    • data-mobile-autofocus
    • data-resource-path
  • Query Strings
    • Query Strings for Specific Forms & Features
  • SmartLinks
  • Hidden Metadata Fields
  • Callbacks
    • Technical background
    • alterErrors
    • alterFill
    • alterFormDefinition
    • alterPost
    • alterRequireValid
    • onSubmit
    • postContributionAmountChanged
    • postFill
    • postPaymentMethodChanged
    • postRender
    • preSegue
    • segue
  • Examples
    • Restyle credit card field using alterFormDefinition
    • alterErrors
    • alterFormDefinition
    • Rearrange fields using alterFormDefinition
    • Conditional redirects with preSegue
    • Get contribution amount in preSegue
    • Change country list using postRender
    • Alter contribution amount options using alterFormDefinition
    • Populate Hidden Metadata Fields with alterPost
    • Remove list attributes
  • Third Party Integrations
    • Using Google Remarketing Codes
    • Google Tag Manager Event Tracking
    • Enhanced ecommerce tracking in Google Tag Manager
    • Cookie Consent Management
Powered by 

Overview

A Worksite is a location associated with an Employer where work is performed.

Updated about 1 year ago


/voterRegistrationBatches/{batchId}/people
Common Models

Updated about 1 year ago


/voterRegistrationBatches/{batchId}/people
Common Models