JUMP TOEveryAction 8OverviewRequest DataAuthenticationData ModelSecurity modelAPI Key ExpirationsErrorsInput ValidationExpansionPaginationJSON PatchEndpointsPublic usersIntrospectionget/echoespostPeopleOverviewCommon Models/peopleget/people/findpost/people/findByPhonepost/people/findOrCreatepost/people/{vanId}post/people/{personIdType}:{personId}post/people/{vanId}/mergeIntoput/people/{vanId}delete/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}delete/people/{personIdType}:{personId}/codes/{codeId}delete/people/{vanId}/myActivistFlagsput/people/{vanId}/myActivistFlagsdelete/people/{vanId}/membershipget/people/{vanId}/namespatchActivist CodesOverviewCommon Models/activistCodesget/activistCodes/{activistCodeId}getBallotsCommon Models/ballotReturnStatusesget/ballotReturnStatuses/{ballotReturnStatusId}get/ballotRequestTypesget/ballotRequestTypes/{ballotRequestTypeId}get/ballotTypesget/ballotTypes/{ballotTypeId}getBargaining UnitsOverviewCommon Models/bargainingUnitsget/bargainingUnits/{bargainingUnitId}get/bargainingUnitspostBulk ImportOverviewConceptual IntroductionWorkflowCommon models/bulkImportJobs/{jobId}get/bulkImportJobs/resourcesget/bulkImportMappingTypesget/bulkImportMappingTypes/{mappingTypeName}get/bulkImportMappingTypes/{mappingTypeName}/{fieldName}/valuesget/bulkImportJobspostCampaignsOverviewCommon Models/campaignsget/campaigns/{campaignId}getCanvass File RequestsOverview/canvassFileRequestspost/canvassFileRequests/{canvassFileRequestId}getCanvass ResponsesOverview/canvassResponses/contactTypesget/canvassResponses/inputTypesget/canvassResponses/resultCodesgetChanged EntitiesOverviewCommon Models/changedEntityExportJobs/resourcesget/changedEntityExportJobs/changeTypes/{resourceType}get/changedEntityExportJobs/fields/{resourceType}get/changedEntityExportJobspost/changedEntityExportJobs/{exportJobId}getCodesOverviewCommon Models/codesget/codes/{codeId}get/codespost/codes/batchpost/codes/{codeId}patch/codesput/codes/{codeId}put/codesdelete/codes/{codeId}delete/codes/supportedEntitiesget/codeTypesgetCommitmentsOverviewCommon Models/commitmentspost/commitments/{commitmentId}patch/commitments/recurringPaymentspostContributionsOverviewCommon models/contributionspost/contributions/{contributionId}get/contributions/{alternateIdType}:{alternateId}get/contributions/attributionTypesget/contributions/{contributionId}/attributions/{vanId}put/contributions/{contributionId}/attributions/{vanId}delete/contributions/{contributionId}/adjustmentspost/contributions/paymentspostCustom FieldsOverviewCommon models/customFieldsget/customFields/{customFieldId}getDepartmentsOverviewCommon Models/departmentsget/departments/{departmentId}getDesignationsOverviewCommon Models/designationsget/designations/{designationId}getDisbursementsOverviewCommon models/disbursementspost/disbursements/{disbursementId}getDistrict FieldsOverviewCommon models/districtFieldsget/districtFields/{districtFieldId}getEmailOverviewCommon models/email/messagesget/email/message/{emailId}getEmployersOverviewCommon Models/employersget/employers/{employerId}get/employers/{employerId}patch/employerspost/employers/{employerId}/bargainingUnits/{bargainingUnitId}post/employers/{employerId}/bargainingUnits/{bargainingUnitId}delete/employers/{employerId}/bargainingUnits/{bargainingUnitId}/jobClasses/{jobClassId}post/employers/{employerId}/bargainingUnits/{bargainingUnitId}/jobClasses/{jobClassId}delete/employers/{employerId}/departmentspost/employers/{employerId}/shiftTypes/{shiftTypeId}post/employers/{employerId}/shiftTypes/{shiftTypeId}delete/employers/{employerId}/worksitespostEvent TypesOverviewCommon models/events/typesget/events/types/{eventTypeId}getEventsOverviewCommon models/eventsget/events/{eventId}get/events/{eventId}patch/eventspost/events/{eventId}/shiftspost/events/{eventId}put/events/{eventId}deleteExport JobsOverviewCommon Models/exportJobTypesget/exportJobspost/exportJobs/{exportJobId}getExtended Source CodesOverviewCommon models/codes/extendedSourceCodesgetFile-Loading JobsOverview/fileLoadingJobspost/fileLoadingJobs/{jobId}get/fileLoadingJobs/{jobId}/statsgetFinancial BatchesOverviewCommon models/financialBatchesget/financialBatches/{financialBatchId}get/financialBatchespostFoldersOverviewCommon Models/foldersget/folders/{folderId}getJob ClassesOverviewCommon models/jobClassesget/jobClasses/{jobClassId}get/jobClassespostLocationsOverviewCommon models/locationsget/locations/{locationId}get/locations/findOrCreatepost/locationspost/locations/{locationId}deleteMember StatusesOverviewCommon models/memberStatusesget/memberStatuses/{memberStatusId}get/memberStatusespostMiniVAN ExportsOverviewCommon models/minivanExportsget/minivanExports/{minivanExportId}getNotesOverviewCommon Models/notes/categoryTypesget/notes/categoriesget/notes/categories/{noteCategoryId}getOnline Actions FormsOverviewCommon Models/onlineActionsFormsget/onlineActionsForms/{formTrackingId}getPhones/phones/isCellStatusesgetPrinted ListsOverviewCommon Models/printedListsget/printedLists/{printedListNumber}getRelationshipsOverview/relationshipsgetReported DemographicsOverview/reportedRacesget/reportedEthnicitiesget/reportedLanguagePreferencesget/reportedSexualOrientationsget/reportedGendersget/pronounsgetSaved ListsOverviewCommon Models/savedListsget/savedLists/{savedListId}get/savedLists/smsSyncpostSchedule TypesOverviewCommon Models/scheduleTypesget/scheduleTypes/{scheduleTypeId}get/scheduleTypespostScore UpdatesOverview/scoreUpdatesget/scoreUpdates/{scoreUpdateId}get/scoreUpdates/{scoreUpdateId}patchScoresOverview/scoresget/scores/{scoreId}get/scores/{scoreId}/committeeAccessgetShift TypesOverviewCommon Models/shiftTypesget/shiftTypes/{shiftTypeId}get/shiftTypespostSignupsOverviewCommon Models/signups/statusesget/signups/{eventSignupId}get/signupsget/signupspost/signups/{eventSignupId}put/signups/{eventSignupId}deleteStoriesOverviewCommon Models/stories/{storyId}get/storiespostSupporter GroupsOverviewCommon Models/supporterGroupsget/supporterGroupspost/supporterGroups/{supporterGroupId}delete/supporterGroups/{supporterGroupId}get/supporterGroups/{supporterGroupId}/people/{vanId}put/supporterGroups/{supporterGroupId}/people/{vanId}deleteSurvey QuestionsOverviewCommon Models/surveyQuestionsget/surveyQuestions/{surveyQuestionId}get/surveyQuestionspost/surveyQuestions/{surveyQuestionId}putTarget Export JobsOverview/targetExportJobspost/targetExportJobs/{exportJobId}getTargetsOverviewCommon Models/targetsget/targets/{targetId}getUsersOverviewCommon Models/users/{userId}/districtFieldValuesget/users/{userId}/districtFieldValuespost/users/{userId}/districtFieldValuesputVoter Registration BatchesOverviewCommon Models/voterRegistrationBatchesget/voterRegistrationBatches/programTypesget/voterRegistrationBatches/registrationFormsget/voterRegistrationBatches/states/{state}/supportedFieldsget/voterRegistrationBatchespost/voterRegistrationBatches/{batchId}patch/voterRegistrationBatches/{batchId}/peoplepostWorksitesOverviewCommon Models/worksitesget/worksites/{worksiteId}get/worksites/{worksiteId}put/worksites/{worksiteId}delete/worksites/{worksiteId}/workAreaspost/worksites/{worksiteId}/workAreas/{workAreaId}put/worksites/{worksiteId}/workAreas/{workAreaId}deleteActionTagOverviewForm EmbeddingHow to find Embed CodeNotes for website builder productsAttributesdata-form-url (required)data-id (legacy implementations)data-databagdata-endpointdata-formdef-endpointdata-labelsdata-mobile-autofocusdata-resource-pathQuery StringsQuery Strings for Specific Forms & FeaturesSmartLinksHidden Metadata FieldsCallbacksTechnical backgroundalterErrorsalterFillalterFormDefinitionalterPostalterRequireValidonSubmitpostContributionAmountChangedpostFillpostPaymentMethodChangedpostRenderpreSeguesegueExamplesRestyle credit card field using alterFormDefinitionalterErrorsalterFormDefinitionRearrange fields using alterFormDefinitionConditional redirects with preSegueGet contribution amount in preSegueChange country list using postRenderAlter contribution amount options using alterFormDefinitionPopulate Hidden Metadata Fields with alterPostRemove list attributesThird Party IntegrationsUsing Google Remarketing CodesGoogle Tag Manager Event TrackingEnhanced ecommerce tracking in Google Tag ManagerCookie Consent ManagementPowered by Common ModelsThe following is an example of a Folder. JSON{ "folderId":44 "name":"API Generated Lists" } Folder Each Folder has the following properties: PropertyTypeDescriptionfolderIdintFolder must be accessible by the API key.namestringFolder name
