OpenField (1.0.0)

Download OpenAPI specification:Download

OpenField Open API V1 Documentation + schema.

address-details

listAddressDetails

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}
]
}

createAddressDetail

Request Body schema:
application/json

address_vf_id	string or null <= 100 characters
usps_line_of_travel	string or null <= 5 characters
usps_line_of_travel_order	string or null <= 4 characters
usps_carrier_route	string or null <= 100 characters
address_type	string or null <= 100 characters
usps_address_type	string or null <= 100 characters
is_seasonal	boolean or null
is_po_box	boolean or null
is_bad	boolean or null
is_mailable	string or null <= 100 characters
is_walkable	boolean or null
address	integer

Responses

Request samples

Payload

Content type

application/json

{"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

addressTypesAddressDetail

Responses

Response samples

200

Content type

application/json

{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

retrieveAddressDetail

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

updateAddressDetail

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

address_vf_id	string or null <= 100 characters
usps_line_of_travel	string or null <= 5 characters
usps_line_of_travel_order	string or null <= 4 characters
usps_carrier_route	string or null <= 100 characters
address_type	string or null <= 100 characters
usps_address_type	string or null <= 100 characters
is_seasonal	boolean or null
is_po_box	boolean or null
is_bad	boolean or null
is_mailable	string or null <= 100 characters
is_walkable	boolean or null
address	integer

Responses

Request samples

Payload

Content type

application/json

{"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

partialUpdateAddressDetail

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

address_vf_id	string or null <= 100 characters
usps_line_of_travel	string or null <= 5 characters
usps_line_of_travel_order	string or null <= 4 characters
usps_carrier_route	string or null <= 100 characters
address_type	string or null <= 100 characters
usps_address_type	string or null <= 100 characters
is_seasonal	boolean or null
is_po_box	boolean or null
is_bad	boolean or null
is_mailable	string or null <= 100 characters
is_walkable	boolean or null
address	integer

Responses

Request samples

Payload

Content type

application/json

{"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

destroyAddressDetail

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertAddressDetail

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

address_vf_id	string or null <= 100 characters
usps_line_of_travel	string or null <= 5 characters
usps_line_of_travel_order	string or null <= 4 characters
usps_carrier_route	string or null <= 100 characters
address_type	string or null <= 100 characters
usps_address_type	string or null <= 100 characters
is_seasonal	boolean or null
is_po_box	boolean or null
is_bad	boolean or null
is_mailable	string or null <= 100 characters
is_walkable	boolean or null
address	integer

Responses

Request samples

Payload

Content type

application/json

{"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"address_vf_id": "string",
"usps_line_of_travel": "strin",
"usps_line_of_travel_order": "stri",
"usps_carrier_route": "string",
"address_type": "string",
"usps_address_type": "string",
"is_seasonal": true,
"is_po_box": true,
"is_bad": true,
"is_mailable": "string",
"is_walkable": true,
"address": 0
}

contact-batches

listContactBatchs

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
owner	string owner
conversation_code	string conversation_code
completed	string completed
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}
]
}

createContactBatch

Request Body schema:
application/json

conversation_code required	integer
contact_matches required	Array of integers
owner required	integer
completed	boolean

Responses

Request samples

Payload

Content type

application/json

{"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

retrieveContactBatch

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
owner	string owner
conversation_code	string conversation_code
completed	string completed
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

updateContactBatch

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
owner	string owner
conversation_code	string conversation_code
completed	string completed
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

conversation_code required	integer
contact_matches required	Array of integers
owner required	integer
completed	boolean

Responses

Request samples

Payload

Content type

application/json

{"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

partialUpdateContactBatch

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
owner	string owner
conversation_code	string conversation_code
completed	string completed
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

conversation_code required	integer
contact_matches required	Array of integers
owner required	integer
completed	boolean

Responses

Request samples

Payload

Content type

application/json

{"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

destroyContactBatch

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
owner	string owner
conversation_code	string conversation_code
completed	string completed
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertContactBatch

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

conversation_code required	integer
contact_matches required	Array of integers
owner required	integer
completed	boolean

Responses

Request samples

Payload

Content type

application/json

{"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"conversation_code": 0,
"contact_matches": [0
],
"owner": 0,
"completed": true
}

contact-matches

listContactMatchs

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
batch	string batch
batch__isnull	string batch__isnull
provider	string Enum: "facebook" "twitter" "google" "apple" provider
provider__isnull	string provider__isnull
contact	string contact
contact__isnull	string contact__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}
]
}

createContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

Request Body schema:
application/json

batch	integer or null
contact required	integer
provider	string or null Enum: "facebook" "twitter" "google" "apple"
contacted	boolean
sequence	integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

retrieveContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters

id

required

string

query Parameters

batch	string batch
batch__isnull	string batch__isnull
provider	string Enum: "facebook" "twitter" "google" "apple" provider
provider__isnull	string provider__isnull
contact	string contact
contact__isnull	string contact__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

updateContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters

id

required

string

query Parameters

batch	string batch
batch__isnull	string batch__isnull
provider	string Enum: "facebook" "twitter" "google" "apple" provider
provider__isnull	string provider__isnull
contact	string contact
contact__isnull	string contact__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

batch	integer or null
contact required	integer
provider	string or null Enum: "facebook" "twitter" "google" "apple"
contacted	boolean
sequence	integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

partialUpdateContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters

id

required

string

query Parameters

batch	string batch
batch__isnull	string batch__isnull
provider	string Enum: "facebook" "twitter" "google" "apple" provider
provider__isnull	string provider__isnull
contact	string contact
contact__isnull	string contact__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

batch	integer or null
contact required	integer
provider	string or null Enum: "facebook" "twitter" "google" "apple"
contacted	boolean
sequence	integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

destroyContactMatch

Contact matches are either created by openfield automatically in case a contact is in our people database, or created by the canvasser to add to the contact-batch in which case the corresponding people should also be created and connected to the contact match.

path Parameters

id

required

string

query Parameters

batch	string batch
batch__isnull	string batch__isnull
provider	string Enum: "facebook" "twitter" "google" "apple" provider
provider__isnull	string provider__isnull
contact	string contact
contact__isnull	string contact__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertContactMatch

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

batch	integer or null
contact required	integer
provider	string or null Enum: "facebook" "twitter" "google" "apple"
contacted	boolean
sequence	integer or null [ -2147483648 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"batch": 0,
"contact": 0,
"provider": "facebook",
"contacted": true,
"sequence": -2147483648
}

content-types

listContentTypes

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"model": "string"
}
]
}

retrieveContentType

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"model": "string"
}

conversation-codes

listConversationCodes

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
created_by	string created_by
created_by__isnull	string created_by__isnull
script	string script
script__isnull	string script__isnull
targets	string targets
targets__isnull	string targets__isnull
expires__gte	string expires__gte
expires__lte	string expires__lte
expires__isnull	string expires__isnull
status	string Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" status
status__isnull	string status__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}
]
}

createConversationCode

Request Body schema:
application/json

description	string <= 255 characters
org	string or null <= 255 characters The organization or cause your canvassers represent. Will display in script.
script required	integer
targets	integer or null
expires	string or null <date-time> Date you want code to expire.
conversation_type	string or null Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time	string or null Time you want contact to begin. Time is local to contact's time zone.
end_time	string or null Time you want contact to end. Time is local to contact's time zone.
status	string or null Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" Deactivated codes will not be accesible by callers or canvassers.
attempt_goal	integer [ -2147483648 .. 2147483647 ] Default goal shown to callers or canvassers.
reg_goal	integer [ -2147483648 .. 2147483647 ] Overall voter registration goal for code.
vbm_goal	integer [ -2147483648 .. 2147483647 ] Overall vote by mail registration goal for code.
conversations_set required	Array of integers
min_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.
max_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.
action_url	string or null <= 255 characters
action_text	string or null <= 255 characters
universal_source_code	string or null <= 100 characters
starting_location	integer or null
skip_people_search	boolean Skip people search when adding people

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

retrieveConversationCode

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
created_by	string created_by
created_by__isnull	string created_by__isnull
script	string script
script__isnull	string script__isnull
targets	string targets
targets__isnull	string targets__isnull
expires__gte	string expires__gte
expires__lte	string expires__lte
expires__isnull	string expires__isnull
status	string Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" status
status__isnull	string status__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

updateConversationCode

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
created_by	string created_by
created_by__isnull	string created_by__isnull
script	string script
script__isnull	string script__isnull
targets	string targets
targets__isnull	string targets__isnull
expires__gte	string expires__gte
expires__lte	string expires__lte
expires__isnull	string expires__isnull
status	string Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" status
status__isnull	string status__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

description	string <= 255 characters
org	string or null <= 255 characters The organization or cause your canvassers represent. Will display in script.
script required	integer
targets	integer or null
expires	string or null <date-time> Date you want code to expire.
conversation_type	string or null Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time	string or null Time you want contact to begin. Time is local to contact's time zone.
end_time	string or null Time you want contact to end. Time is local to contact's time zone.
status	string or null Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" Deactivated codes will not be accesible by callers or canvassers.
attempt_goal	integer [ -2147483648 .. 2147483647 ] Default goal shown to callers or canvassers.
reg_goal	integer [ -2147483648 .. 2147483647 ] Overall voter registration goal for code.
vbm_goal	integer [ -2147483648 .. 2147483647 ] Overall vote by mail registration goal for code.
conversations_set required	Array of integers
min_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.
max_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.
action_url	string or null <= 255 characters
action_text	string or null <= 255 characters
universal_source_code	string or null <= 100 characters
starting_location	integer or null
skip_people_search	boolean Skip people search when adding people

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

partialUpdateConversationCode

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
created_by	string created_by
created_by__isnull	string created_by__isnull
script	string script
script__isnull	string script__isnull
targets	string targets
targets__isnull	string targets__isnull
expires__gte	string expires__gte
expires__lte	string expires__lte
expires__isnull	string expires__isnull
status	string Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" status
status__isnull	string status__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

description	string <= 255 characters
org	string or null <= 255 characters The organization or cause your canvassers represent. Will display in script.
script required	integer
targets	integer or null
expires	string or null <date-time> Date you want code to expire.
conversation_type	string or null Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time	string or null Time you want contact to begin. Time is local to contact's time zone.
end_time	string or null Time you want contact to end. Time is local to contact's time zone.
status	string or null Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" Deactivated codes will not be accesible by callers or canvassers.
attempt_goal	integer [ -2147483648 .. 2147483647 ] Default goal shown to callers or canvassers.
reg_goal	integer [ -2147483648 .. 2147483647 ] Overall voter registration goal for code.
vbm_goal	integer [ -2147483648 .. 2147483647 ] Overall vote by mail registration goal for code.
conversations_set required	Array of integers
min_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.
max_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.
action_url	string or null <= 255 characters
action_text	string or null <= 255 characters
universal_source_code	string or null <= 100 characters
starting_location	integer or null
skip_people_search	boolean Skip people search when adding people

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

destroyConversationCode

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
created_by	string created_by
created_by__isnull	string created_by__isnull
script	string script
script__isnull	string script__isnull
targets	string targets
targets__isnull	string targets__isnull
expires__gte	string expires__gte
expires__lte	string expires__lte
expires__isnull	string expires__isnull
status	string Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" status
status__isnull	string status__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

progressConversationCode

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

bulkUpsertConversationCode

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

description	string <= 255 characters
org	string or null <= 255 characters The organization or cause your canvassers represent. Will display in script.
script required	integer
targets	integer or null
expires	string or null <date-time> Date you want code to expire.
conversation_type	string or null Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
start_time	string or null Time you want contact to begin. Time is local to contact's time zone.
end_time	string or null Time you want contact to end. Time is local to contact's time zone.
status	string or null Enum: "Processing" "Active" "After Hours" "Expired" "Deactivated" Deactivated codes will not be accesible by callers or canvassers.
attempt_goal	integer [ -2147483648 .. 2147483647 ] Default goal shown to callers or canvassers.
reg_goal	integer [ -2147483648 .. 2147483647 ] Overall voter registration goal for code.
vbm_goal	integer [ -2147483648 .. 2147483647 ] Overall vote by mail registration goal for code.
conversations_set required	Array of integers
min_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a minimum number of doors per turf. For every door, set the number to 1; for dense turfs only we recommend ~10-30 doors.
max_turf_size	integer or null [ -2147483648 .. 2147483647 ] Set a maximum number of doors per turf. For dense apartments, we recommend 1000 doors. For single family neighborhoods 50-100 doors.
action_url	string or null <= 255 characters
action_text	string or null <= 255 characters
universal_source_code	string or null <= 100 characters
starting_location	integer or null
skip_people_search	boolean Skip people search when adding people

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"code": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"display": "string",
"org": "string",
"script": 0,
"targets": 0,
"expires": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"start_time": "string",
"end_time": "string",
"status": "Processing",
"attempt_goal": -2147483648,
"reg_goal": -2147483648,
"vbm_goal": -2147483648,
"conversations_set": [0
],
"min_turf_size": -2147483648,
"max_turf_size": -2147483648,
"action_url": "string",
"action_text": "string",
"universal_source_code": "string",
"starting_location": 0,
"skip_people_search": true
}

cc-leaderboard

listCCLeaderboards

query Parameters

page	integer A page number within the paginated result set.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"code": "string",
"description": "string",
"attempts": 0,
"contacts": 0
}
]
}

createCCLeaderboard

Request Body schema:
application/json

description	string <= 255 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"attempts": 0,
"contacts": 0
}

retrieveCCLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"attempts": 0,
"contacts": 0
}

updateCCLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

description	string <= 255 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"attempts": 0,
"contacts": 0
}

partialUpdateCCLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

description	string <= 255 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"attempts": 0,
"contacts": 0
}

destroyCCLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertCCLeaderboard

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

description	string <= 255 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"attempts": 0,
"contacts": 0
}

conversations

listConversations

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
canvasser	string canvasser
canvasser__isnull	string canvasser__isnull
contacted_id	string contacted_id
contacted_id__isnull	string contacted_id__isnull
conversation_time	string conversation_time
conversation_time__gte	string conversation_time__gte
conversation_time__lte	string conversation_time__lte
conversation_time__isnull	string conversation_time__isnull
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO" conversation_type
conversation_type__isnull	string conversation_type__isnull
contact_type	string Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL" contact_type
contact_type__isnull	string contact_type__isnull
contact	string contact
contact__isnull	string contact__isnull
conversation_code	string conversation_code
conversation_code__isnull	string conversation_code__isnull
contact_script	string contact_script
contact_script__isnull	string contact_script__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
relationship_type	string Enum: "0R" "1R" "2R" "3R" relationship_type
relationship_type__isnull	string relationship_type__isnull
languages_of_conversation	string languages_of_conversation
languages_of_conversation__isnull	string languages_of_conversation__isnull
attempt	string Attempt
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"canvasser": "string",
"contacted_id": 0,
"conversation_time": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}
]
}

createConversation

Request Body schema:
application/json

canvasser	string
contacted_id	integer or null
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type	string or null Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact	boolean or null
conversation_code	integer
contact_script	integer
contacted_national_address_id	integer or null
contacted_phone	string or null <= 128 characters
relationship_type	string or null Enum: "0R" "1R" "2R" "3R"
languages_of_conversation	integer or null
questions_set	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"canvasser": "string",
"contacted_id": 0,
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"canvasser": "string",
"contacted_id": 0,
"conversation_time": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

retrieveConversation

path Parameters

id

required

string

query Parameters

canvasser	string canvasser
canvasser__isnull	string canvasser__isnull
contacted_id	string contacted_id
contacted_id__isnull	string contacted_id__isnull
conversation_time	string conversation_time
conversation_time__gte	string conversation_time__gte
conversation_time__lte	string conversation_time__lte
conversation_time__isnull	string conversation_time__isnull
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO" conversation_type
conversation_type__isnull	string conversation_type__isnull
contact_type	string Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL" contact_type
contact_type__isnull	string contact_type__isnull
contact	string contact
contact__isnull	string contact__isnull
conversation_code	string conversation_code
conversation_code__isnull	string conversation_code__isnull
contact_script	string contact_script
contact_script__isnull	string contact_script__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
relationship_type	string Enum: "0R" "1R" "2R" "3R" relationship_type
relationship_type__isnull	string relationship_type__isnull
languages_of_conversation	string languages_of_conversation
languages_of_conversation__isnull	string languages_of_conversation__isnull
attempt	string Attempt
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"canvasser": "string",
"contacted_id": 0,
"conversation_time": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

updateConversation

path Parameters

id

required

string

query Parameters

canvasser	string canvasser
canvasser__isnull	string canvasser__isnull
contacted_id	string contacted_id
contacted_id__isnull	string contacted_id__isnull
conversation_time	string conversation_time
conversation_time__gte	string conversation_time__gte
conversation_time__lte	string conversation_time__lte
conversation_time__isnull	string conversation_time__isnull
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO" conversation_type
conversation_type__isnull	string conversation_type__isnull
contact_type	string Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL" contact_type
contact_type__isnull	string contact_type__isnull
contact	string contact
contact__isnull	string contact__isnull
conversation_code	string conversation_code
conversation_code__isnull	string conversation_code__isnull
contact_script	string contact_script
contact_script__isnull	string contact_script__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
relationship_type	string Enum: "0R" "1R" "2R" "3R" relationship_type
relationship_type__isnull	string relationship_type__isnull
languages_of_conversation	string languages_of_conversation
languages_of_conversation__isnull	string languages_of_conversation__isnull
attempt	string Attempt
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

canvasser	string
contacted_id	integer or null
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type	string or null Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact	boolean or null
conversation_code	integer
contact_script	integer
contacted_national_address_id	integer or null
contacted_phone	string or null <= 128 characters
relationship_type	string or null Enum: "0R" "1R" "2R" "3R"
languages_of_conversation	integer or null
questions_set	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"canvasser": "string",
"contacted_id": 0,
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"canvasser": "string",
"contacted_id": 0,
"conversation_time": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

partialUpdateConversation

path Parameters

id

required

string

query Parameters

canvasser	string canvasser
canvasser__isnull	string canvasser__isnull
contacted_id	string contacted_id
contacted_id__isnull	string contacted_id__isnull
conversation_time	string conversation_time
conversation_time__gte	string conversation_time__gte
conversation_time__lte	string conversation_time__lte
conversation_time__isnull	string conversation_time__isnull
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO" conversation_type
conversation_type__isnull	string conversation_type__isnull
contact_type	string Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL" contact_type
contact_type__isnull	string contact_type__isnull
contact	string contact
contact__isnull	string contact__isnull
conversation_code	string conversation_code
conversation_code__isnull	string conversation_code__isnull
contact_script	string contact_script
contact_script__isnull	string contact_script__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
relationship_type	string Enum: "0R" "1R" "2R" "3R" relationship_type
relationship_type__isnull	string relationship_type__isnull
languages_of_conversation	string languages_of_conversation
languages_of_conversation__isnull	string languages_of_conversation__isnull
attempt	string Attempt
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

canvasser	string
contacted_id	integer or null
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type	string or null Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact	boolean or null
conversation_code	integer
contact_script	integer
contacted_national_address_id	integer or null
contacted_phone	string or null <= 128 characters
relationship_type	string or null Enum: "0R" "1R" "2R" "3R"
languages_of_conversation	integer or null
questions_set	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"canvasser": "string",
"contacted_id": 0,
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"canvasser": "string",
"contacted_id": 0,
"conversation_time": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

destroyConversation

path Parameters

id

required

string

query Parameters

canvasser	string canvasser
canvasser__isnull	string canvasser__isnull
contacted_id	string contacted_id
contacted_id__isnull	string contacted_id__isnull
conversation_time	string conversation_time
conversation_time__gte	string conversation_time__gte
conversation_time__lte	string conversation_time__lte
conversation_time__isnull	string conversation_time__isnull
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO" conversation_type
conversation_type__isnull	string conversation_type__isnull
contact_type	string Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL" contact_type
contact_type__isnull	string contact_type__isnull
contact	string contact
contact__isnull	string contact__isnull
conversation_code	string conversation_code
conversation_code__isnull	string conversation_code__isnull
contact_script	string contact_script
contact_script__isnull	string contact_script__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
relationship_type	string Enum: "0R" "1R" "2R" "3R" relationship_type
relationship_type__isnull	string relationship_type__isnull
languages_of_conversation	string languages_of_conversation
languages_of_conversation__isnull	string languages_of_conversation__isnull
attempt	string Attempt
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertConversation

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

canvasser	string
contacted_id	integer or null
conversation_type	string Enum: "VK" "PK" "VR" "PR" "VC" "PC" "VD" "PD" "ST" "RO"
contact_type	string or null Enum: "NH" "WN" "LM" "RF" "HS" "DC" "MV" "IA" "LD" "OL"
contact	boolean or null
conversation_code	integer
contact_script	integer
contacted_national_address_id	integer or null
contacted_phone	string or null <= 128 characters
relationship_type	string or null Enum: "0R" "1R" "2R" "3R"
languages_of_conversation	integer or null
questions_set	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"canvasser": "string",
"contacted_id": 0,
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"canvasser": "string",
"contacted_id": 0,
"conversation_time": "2019-08-24T14:15:22Z",
"conversation_type": "VK",
"contact_type": "NH",
"contact": true,
"conversation_code": 0,
"contact_script": 0,
"contacted_national_address_id": 0,
"contacted_phone": "string",
"relationship_type": "0R",
"languages_of_conversation": 0,
"questions_set": ["string"
]
}

districts

listDistricts

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}
]
}

createDistrict

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
media_market	string or null <= 100 characters
state_county_fips	string or null <= 100 characters
county_fips	string or null <= 100 characters
county_name	string or null <= 100 characters
sos_county_code	string or null <= 100 characters
township	string or null <= 100 characters
precinct_code	string or null <= 100 characters
precinct_name	string or null <= 100 characters
precinct_split	string or null <= 100 characters
unique_precinct_code	string or null <= 100 characters
unique_precinct_name	string or null <= 100 characters
ward	string or null <= 100 characters
congressional	string or null <= 100 characters
state_senate	string or null <= 100 characters
state_house	string or null <= 100 characters
municipal_district	string or null <= 100 characters
city_council_district	string or null <= 100 characters
county_commission	string or null <= 100 characters
county_legislative	string or null <= 100 characters
county_supervisor_district	string or null <= 100 characters
school_board	string or null <= 100 characters
school_district	string or null <= 100 characters
judicial_district	string or null <= 100 characters
elementary_school	string or null
middle_school	string or null
high_school	string or null
person	integer
address	integer
misc_districts	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

autocompleteOptionsDistrict

Responses

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

retrieveDistrict

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

updateDistrict

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
media_market	string or null <= 100 characters
state_county_fips	string or null <= 100 characters
county_fips	string or null <= 100 characters
county_name	string or null <= 100 characters
sos_county_code	string or null <= 100 characters
township	string or null <= 100 characters
precinct_code	string or null <= 100 characters
precinct_name	string or null <= 100 characters
precinct_split	string or null <= 100 characters
unique_precinct_code	string or null <= 100 characters
unique_precinct_name	string or null <= 100 characters
ward	string or null <= 100 characters
congressional	string or null <= 100 characters
state_senate	string or null <= 100 characters
state_house	string or null <= 100 characters
municipal_district	string or null <= 100 characters
city_council_district	string or null <= 100 characters
county_commission	string or null <= 100 characters
county_legislative	string or null <= 100 characters
county_supervisor_district	string or null <= 100 characters
school_board	string or null <= 100 characters
school_district	string or null <= 100 characters
judicial_district	string or null <= 100 characters
elementary_school	string or null
middle_school	string or null
high_school	string or null
person	integer
address	integer
misc_districts	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

partialUpdateDistrict

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
media_market	string or null <= 100 characters
state_county_fips	string or null <= 100 characters
county_fips	string or null <= 100 characters
county_name	string or null <= 100 characters
sos_county_code	string or null <= 100 characters
township	string or null <= 100 characters
precinct_code	string or null <= 100 characters
precinct_name	string or null <= 100 characters
precinct_split	string or null <= 100 characters
unique_precinct_code	string or null <= 100 characters
unique_precinct_name	string or null <= 100 characters
ward	string or null <= 100 characters
congressional	string or null <= 100 characters
state_senate	string or null <= 100 characters
state_house	string or null <= 100 characters
municipal_district	string or null <= 100 characters
city_council_district	string or null <= 100 characters
county_commission	string or null <= 100 characters
county_legislative	string or null <= 100 characters
county_supervisor_district	string or null <= 100 characters
school_board	string or null <= 100 characters
school_district	string or null <= 100 characters
judicial_district	string or null <= 100 characters
elementary_school	string or null
middle_school	string or null
high_school	string or null
person	integer
address	integer
misc_districts	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

destroyDistrict

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertDistrict

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
media_market	string or null <= 100 characters
state_county_fips	string or null <= 100 characters
county_fips	string or null <= 100 characters
county_name	string or null <= 100 characters
sos_county_code	string or null <= 100 characters
township	string or null <= 100 characters
precinct_code	string or null <= 100 characters
precinct_name	string or null <= 100 characters
precinct_split	string or null <= 100 characters
unique_precinct_code	string or null <= 100 characters
unique_precinct_name	string or null <= 100 characters
ward	string or null <= 100 characters
congressional	string or null <= 100 characters
state_senate	string or null <= 100 characters
state_house	string or null <= 100 characters
municipal_district	string or null <= 100 characters
city_council_district	string or null <= 100 characters
county_commission	string or null <= 100 characters
county_legislative	string or null <= 100 characters
county_supervisor_district	string or null <= 100 characters
school_board	string or null <= 100 characters
school_district	string or null <= 100 characters
judicial_district	string or null <= 100 characters
elementary_school	string or null
middle_school	string or null
high_school	string or null
person	integer
address	integer
misc_districts	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"media_market": "string",
"state_county_fips": "string",
"county_fips": "string",
"county_name": "string",
"sos_county_code": "string",
"township": "string",
"precinct_code": "string",
"precinct_name": "string",
"precinct_split": "string",
"unique_precinct_code": "string",
"unique_precinct_name": "string",
"ward": "string",
"congressional": "string",
"state_senate": "string",
"state_house": "string",
"municipal_district": "string",
"city_council_district": "string",
"county_commission": "string",
"county_legislative": "string",
"county_supervisor_district": "string",
"school_board": "string",
"school_district": "string",
"judicial_district": "string",
"elementary_school": "string",
"middle_school": "string",
"high_school": "string",
"person": 0,
"address": 0,
"misc_districts": [0
]
}

external-data

listExternalDatas

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
mapping_type	string Enum: "mobilize-attendance" "mobilize-event" mapping_type
mapping_type__isnull	string mapping_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}
]
}

createExternalData

Request Body schema:
application/json

mapping	object or null
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]
mapping_type required	string Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

retrieveExternalData

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
mapping_type	string Enum: "mobilize-attendance" "mobilize-event" mapping_type
mapping_type__isnull	string mapping_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

updateExternalData

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
mapping_type	string Enum: "mobilize-attendance" "mobilize-event" mapping_type
mapping_type__isnull	string mapping_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

mapping	object or null
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]
mapping_type required	string Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

partialUpdateExternalData

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
mapping_type	string Enum: "mobilize-attendance" "mobilize-event" mapping_type
mapping_type__isnull	string mapping_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

mapping	object or null
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]
mapping_type required	string Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

destroyExternalData

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
mapping_type	string Enum: "mobilize-attendance" "mobilize-event" mapping_type
mapping_type__isnull	string mapping_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertExternalData

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

mapping	object or null
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]
mapping_type required	string Enum: "mobilize-attendance" "mobilize-event"

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647,
"mapping_type": "mobilize-attendance"
}

identities

listIdentitys

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}
]
}

createIdentity

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
household_id1	string <= 10 characters
household_id2	string <= 10 characters
next_election_age	integer [ -2147483648 .. 2147483647 ]
next_federal_election_age	integer [ -2147483648 .. 2147483647 ]
sex	string or null Enum: "Male" "Female" "Non-Binary"
sex_source	string <= 25 characters
race	string or null Enum: "Asian" "African-American" "Caucasian" "Hispanic" "Native American" "Multiracial" "Other" "Uncoded"
race_source	string <= 25 characters
race_confidence	string <= 25 characters
ethnicity	string or null <= 100 characters
religion	string or null Enum: "Atheist" "Agnostic" "Buddhist" "Catholic" "Ethiopian Orthodox" "Greek Orthodox" "Eastern Orthodox" "Hindu" "Jewish" "Mormon" "Muslim" "Protestant" "Sikh" "Shinto" "Unknown"
is_military	boolean or null
current_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
previous_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
person	integer
occupation_affiliations	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

retrieveIdentity

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

updateIdentity

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
household_id1	string <= 10 characters
household_id2	string <= 10 characters
next_election_age	integer [ -2147483648 .. 2147483647 ]
next_federal_election_age	integer [ -2147483648 .. 2147483647 ]
sex	string or null Enum: "Male" "Female" "Non-Binary"
sex_source	string <= 25 characters
race	string or null Enum: "Asian" "African-American" "Caucasian" "Hispanic" "Native American" "Multiracial" "Other" "Uncoded"
race_source	string <= 25 characters
race_confidence	string <= 25 characters
ethnicity	string or null <= 100 characters
religion	string or null Enum: "Atheist" "Agnostic" "Buddhist" "Catholic" "Ethiopian Orthodox" "Greek Orthodox" "Eastern Orthodox" "Hindu" "Jewish" "Mormon" "Muslim" "Protestant" "Sikh" "Shinto" "Unknown"
is_military	boolean or null
current_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
previous_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
person	integer
occupation_affiliations	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

partialUpdateIdentity

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
household_id1	string <= 10 characters
household_id2	string <= 10 characters
next_election_age	integer [ -2147483648 .. 2147483647 ]
next_federal_election_age	integer [ -2147483648 .. 2147483647 ]
sex	string or null Enum: "Male" "Female" "Non-Binary"
sex_source	string <= 25 characters
race	string or null Enum: "Asian" "African-American" "Caucasian" "Hispanic" "Native American" "Multiracial" "Other" "Uncoded"
race_source	string <= 25 characters
race_confidence	string <= 25 characters
ethnicity	string or null <= 100 characters
religion	string or null Enum: "Atheist" "Agnostic" "Buddhist" "Catholic" "Ethiopian Orthodox" "Greek Orthodox" "Eastern Orthodox" "Hindu" "Jewish" "Mormon" "Muslim" "Protestant" "Sikh" "Shinto" "Unknown"
is_military	boolean or null
current_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
previous_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
person	integer
occupation_affiliations	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

destroyIdentity

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertIdentity

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
household_id1	string <= 10 characters
household_id2	string <= 10 characters
next_election_age	integer [ -2147483648 .. 2147483647 ]
next_federal_election_age	integer [ -2147483648 .. 2147483647 ]
sex	string or null Enum: "Male" "Female" "Non-Binary"
sex_source	string <= 25 characters
race	string or null Enum: "Asian" "African-American" "Caucasian" "Hispanic" "Native American" "Multiracial" "Other" "Uncoded"
race_source	string <= 25 characters
race_confidence	string <= 25 characters
ethnicity	string or null <= 100 characters
religion	string or null Enum: "Atheist" "Agnostic" "Buddhist" "Catholic" "Ethiopian Orthodox" "Greek Orthodox" "Eastern Orthodox" "Hindu" "Jewish" "Mormon" "Muslim" "Protestant" "Sikh" "Shinto" "Unknown"
is_military	boolean or null
current_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
previous_party_affiliation	string or null Enum: "Conservative" "Democrat" "Green" "Independent" "Libertarian" "No Party" "Other" "Peace and Freedom" "Republican" "Unaffiliated" "Unknown" "Working Families"
person	integer
occupation_affiliations	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"household_id1": "string",
"household_id2": "string",
"next_election_age": -2147483648,
"next_federal_election_age": -2147483648,
"sex": "Male",
"sex_source": "string",
"race": "Asian",
"race_source": "string",
"race_confidence": "string",
"ethnicity": "string",
"religion": "Atheist",
"is_military": true,
"current_party_affiliation": "Conservative",
"previous_party_affiliation": "Conservative",
"person": 0,
"occupation_affiliations": [0
]
}

labels

listLabels

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
people__isnull	string people__isnull
people	string People
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"name": "string",
"description": "string",
"display": "string"
}
]
}

createLabel

Request Body schema:
application/json

name required	string <= 100 characters
description required	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"description": "string",
"display": "string"
}

retrieveLabel

path Parameters

id

required

string

query Parameters

people__isnull	string people__isnull
people	string People
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"description": "string",
"display": "string"
}

updateLabel

path Parameters

id

required

string

query Parameters

people__isnull	string people__isnull
people	string People
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 100 characters
description required	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"description": "string",
"display": "string"
}

partialUpdateLabel

path Parameters

id

required

string

query Parameters

people__isnull	string people__isnull
people	string People
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 100 characters
description required	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"description": "string",
"display": "string"
}

destroyLabel

path Parameters

id

required

string

query Parameters

people__isnull	string people__isnull
people	string People
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertLabel

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

name required	string <= 100 characters
description required	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"description": "string",
"display": "string"
}

languages

listLanguages

query Parameters

page	integer A page number within the paginated result set.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"isocode": "str",
"name": "string",
"sorting": 2147483647
}
]
}

createLanguage

Request Body schema:
application/json

isocode required	string <= 3 characters
name required	string <= 255 characters
sorting	integer [ 0 .. 2147483647 ] increase number to raise display on list

Responses

Request samples

Payload

Content type

application/json

{"isocode": "str",
"name": "string",
"sorting": 2147483647
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"isocode": "str",
"name": "string",
"sorting": 2147483647
}

retrieveLanguage

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"isocode": "str",
"name": "string",
"sorting": 2147483647
}

updateLanguage

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

isocode required	string <= 3 characters
name required	string <= 255 characters
sorting	integer [ 0 .. 2147483647 ] increase number to raise display on list

Responses

Request samples

Payload

Content type

application/json

{"isocode": "str",
"name": "string",
"sorting": 2147483647
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"isocode": "str",
"name": "string",
"sorting": 2147483647
}

partialUpdateLanguage

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

isocode required	string <= 3 characters
name required	string <= 255 characters
sorting	integer [ 0 .. 2147483647 ] increase number to raise display on list

Responses

Request samples

Payload

Content type

application/json

{"isocode": "str",
"name": "string",
"sorting": 2147483647
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"isocode": "str",
"name": "string",
"sorting": 2147483647
}

destroyLanguage

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertLanguage

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

isocode required	string <= 3 characters
name required	string <= 255 characters
sorting	integer [ 0 .. 2147483647 ] increase number to raise display on list

Responses

Request samples

Payload

Content type

application/json

{"isocode": "str",
"name": "string",
"sorting": 2147483647
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"isocode": "str",
"name": "string",
"sorting": 2147483647
}

list-filter-items

listListFilterItems

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
lookup	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull" lookup
lookup__isnull	string lookup__isnull
field	string field
field__isnull	string field__isnull
value_type	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST" value_type
value_type__isnull	string value_type__isnull
value	string value
value__isnull	string value__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true,
"human_readable_representation": "string"
}
]
}

createListFilterItem

Request Body schema:
application/json

name required	string <= 500 characters
list_filter required	integer
field required	string <= 500 characters
lookup required	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull"
value required	string
value_type required	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST"
is_negated	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true,
"human_readable_representation": "string"
}

retrieveListFilterItem

path Parameters

id

required

string

query Parameters

list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
lookup	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull" lookup
lookup__isnull	string lookup__isnull
field	string field
field__isnull	string field__isnull
value_type	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST" value_type
value_type__isnull	string value_type__isnull
value	string value
value__isnull	string value__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true,
"human_readable_representation": "string"
}

updateListFilterItem

path Parameters

id

required

string

query Parameters

list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
lookup	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull" lookup
lookup__isnull	string lookup__isnull
field	string field
field__isnull	string field__isnull
value_type	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST" value_type
value_type__isnull	string value_type__isnull
value	string value
value__isnull	string value__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 500 characters
list_filter required	integer
field required	string <= 500 characters
lookup required	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull"
value required	string
value_type required	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST"
is_negated	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true,
"human_readable_representation": "string"
}

partialUpdateListFilterItem

path Parameters

id

required

string

query Parameters

list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
lookup	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull" lookup
lookup__isnull	string lookup__isnull
field	string field
field__isnull	string field__isnull
value_type	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST" value_type
value_type__isnull	string value_type__isnull
value	string value
value__isnull	string value__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 500 characters
list_filter required	integer
field required	string <= 500 characters
lookup required	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull"
value required	string
value_type required	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST"
is_negated	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true,
"human_readable_representation": "string"
}

destroyListFilterItem

path Parameters

id

required

string

query Parameters

list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
lookup	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull" lookup
lookup__isnull	string lookup__isnull
field	string field
field__isnull	string field__isnull
value_type	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST" value_type
value_type__isnull	string value_type__isnull
value	string value
value__isnull	string value__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertListFilterItem

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

name required	string <= 500 characters
list_filter required	integer
field required	string <= 500 characters
lookup required	string Enum: "startswith" "endswith" "contains" "exact" "icontains" "istartswith" "iendswith" "iexact" "in" "iin" "gt" "lt" "gte" "lte" "isnull"
value required	string
value_type required	string Enum: "STR" "INT" "DECIMAL" "BOOL" "DATE" "STR_LIST" "INT_LIST" "BOOL_LIST" "DATE_LIST" "DECIMAL_LIST"
is_negated	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"list_filter": 0,
"field": "string",
"lookup": "startswith",
"value": "string",
"value_type": "STR",
"is_negated": true,
"human_readable_representation": "string"
}

list-filters

listListFilters

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
connector	string Enum: "AND" "OR" connector
connector__isnull	string connector__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
target_list	string target_list
target_list__isnull	string target_list__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"human_readable_representation": "string",
"step_input": 0
}
]
}

createListFilter

Request Body schema:
application/json

name required	string <= 500 characters
connector	string Enum: "AND" "OR"
is_negated	boolean
list_filter	integer or null
target_list	integer or null
step_input required	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"step_input": 0
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"human_readable_representation": "string",
"step_input": 0
}

retrieveListFilter

path Parameters

id

required

string

query Parameters

connector	string Enum: "AND" "OR" connector
connector__isnull	string connector__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
target_list	string target_list
target_list__isnull	string target_list__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"human_readable_representation": "string",
"step_input": 0
}

updateListFilter

path Parameters

id

required

string

query Parameters

connector	string Enum: "AND" "OR" connector
connector__isnull	string connector__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
target_list	string target_list
target_list__isnull	string target_list__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 500 characters
connector	string Enum: "AND" "OR"
is_negated	boolean
list_filter	integer or null
target_list	integer or null
step_input required	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"step_input": 0
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"human_readable_representation": "string",
"step_input": 0
}

partialUpdateListFilter

path Parameters

id

required

string

query Parameters

connector	string Enum: "AND" "OR" connector
connector__isnull	string connector__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
target_list	string target_list
target_list__isnull	string target_list__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 500 characters
connector	string Enum: "AND" "OR"
is_negated	boolean
list_filter	integer or null
target_list	integer or null
step_input required	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"step_input": 0
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"human_readable_representation": "string",
"step_input": 0
}

destroyListFilter

path Parameters

id

required

string

query Parameters

connector	string Enum: "AND" "OR" connector
connector__isnull	string connector__isnull
is_negated	string is_negated
is_negated__isnull	string is_negated__isnull
list_filter	string list_filter
list_filter__isnull	string list_filter__isnull
target_list	string target_list
target_list__isnull	string target_list__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertListFilter

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

name required	string <= 500 characters
connector	string Enum: "AND" "OR"
is_negated	boolean
list_filter	integer or null
target_list	integer or null
step_input required	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"step_input": 0
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"connector": "AND",
"is_negated": true,
"list_filter": 0,
"target_list": 0,
"human_readable_representation": "string",
"step_input": 0
}

national-addresses

listNationalAddress

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
even_or_odd	string Enum: "E" "O" "S" even_or_odd
even_or_odd__isnull	string even_or_odd__isnull
census_block	string census_block
census_block__isnull	string census_block__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}
]
}

createNationalAddress

Request Body schema:
application/json

os_naid_hash	string or null <= 100 characters
dot_guid	string or null <= 100 characters
full_address	string or null <= 1000 characters
has_units	boolean or null
building_id	string or null <= 100 characters
address12	string or null <= 500 characters
address1	string or null <= 100 characters
address2	string or null <= 100 characters
street_number	string or null <= 20 characters
street_name	string or null <= 100 characters
building	string or null <= 100 characters
unit	string or null <= 50 characters
p_city	string or null <= 100 characters
p_state	string or null <= 2 characters
p_county	string or null <= 100 characters
p_zip_5	string or null <= 5 characters
p_zip_4	string or null <= 4 characters
country	string or null <= 500 characters
even_or_odd	string or null Enum: "E" "O" "S"
precinct_name	string or null <= 20 characters
precinct_number	string or null <= 20 characters
polling_location	string or null <= 200 characters
polling_location_address	string or null <= 200 characters
municipality	string or null <= 100 characters
ward	string or null <= 20 characters
citydistrict	string or null <= 20 characters
lower_state_leg	string or null <= 20 characters
upper_state_leg	string or null <= 20 characters
congressional	string or null <= 20 characters
raw_lat_long	string or null <= 500 characters
raw_lat	number or null
raw_long	number or null
geom	string or null
labels	Array of integers
local_door_notes	string or null <= 500 characters
census_block	integer or null

Responses

Request samples

Payload

Content type

application/json

{"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

Response samples

201

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

citiesNationalAddress

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

countiesNationalAddress

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

zipCodesNationalAddress

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

retrieveNationalAddress

path Parameters

id

required

string

query Parameters

even_or_odd	string Enum: "E" "O" "S" even_or_odd
even_or_odd__isnull	string even_or_odd__isnull
census_block	string census_block
census_block__isnull	string census_block__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

updateNationalAddress

path Parameters

id

required

string

query Parameters

even_or_odd	string Enum: "E" "O" "S" even_or_odd
even_or_odd__isnull	string even_or_odd__isnull
census_block	string census_block
census_block__isnull	string census_block__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

os_naid_hash	string or null <= 100 characters
dot_guid	string or null <= 100 characters
full_address	string or null <= 1000 characters
has_units	boolean or null
building_id	string or null <= 100 characters
address12	string or null <= 500 characters
address1	string or null <= 100 characters
address2	string or null <= 100 characters
street_number	string or null <= 20 characters
street_name	string or null <= 100 characters
building	string or null <= 100 characters
unit	string or null <= 50 characters
p_city	string or null <= 100 characters
p_state	string or null <= 2 characters
p_county	string or null <= 100 characters
p_zip_5	string or null <= 5 characters
p_zip_4	string or null <= 4 characters
country	string or null <= 500 characters
even_or_odd	string or null Enum: "E" "O" "S"
precinct_name	string or null <= 20 characters
precinct_number	string or null <= 20 characters
polling_location	string or null <= 200 characters
polling_location_address	string or null <= 200 characters
municipality	string or null <= 100 characters
ward	string or null <= 20 characters
citydistrict	string or null <= 20 characters
lower_state_leg	string or null <= 20 characters
upper_state_leg	string or null <= 20 characters
congressional	string or null <= 20 characters
raw_lat_long	string or null <= 500 characters
raw_lat	number or null
raw_long	number or null
geom	string or null
labels	Array of integers
local_door_notes	string or null <= 500 characters
census_block	integer or null

Responses

Request samples

Payload

Content type

application/json

{"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

Response samples

200

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

partialUpdateNationalAddress

path Parameters

id

required

string

query Parameters

even_or_odd	string Enum: "E" "O" "S" even_or_odd
even_or_odd__isnull	string even_or_odd__isnull
census_block	string census_block
census_block__isnull	string census_block__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

os_naid_hash	string or null <= 100 characters
dot_guid	string or null <= 100 characters
full_address	string or null <= 1000 characters
has_units	boolean or null
building_id	string or null <= 100 characters
address12	string or null <= 500 characters
address1	string or null <= 100 characters
address2	string or null <= 100 characters
street_number	string or null <= 20 characters
street_name	string or null <= 100 characters
building	string or null <= 100 characters
unit	string or null <= 50 characters
p_city	string or null <= 100 characters
p_state	string or null <= 2 characters
p_county	string or null <= 100 characters
p_zip_5	string or null <= 5 characters
p_zip_4	string or null <= 4 characters
country	string or null <= 500 characters
even_or_odd	string or null Enum: "E" "O" "S"
precinct_name	string or null <= 20 characters
precinct_number	string or null <= 20 characters
polling_location	string or null <= 200 characters
polling_location_address	string or null <= 200 characters
municipality	string or null <= 100 characters
ward	string or null <= 20 characters
citydistrict	string or null <= 20 characters
lower_state_leg	string or null <= 20 characters
upper_state_leg	string or null <= 20 characters
congressional	string or null <= 20 characters
raw_lat_long	string or null <= 500 characters
raw_lat	number or null
raw_long	number or null
geom	string or null
labels	Array of integers
local_door_notes	string or null <= 500 characters
census_block	integer or null

Responses

Request samples

Payload

Content type

application/json

{"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

Response samples

200

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

destroyNationalAddress

path Parameters

id

required

string

query Parameters

even_or_odd	string Enum: "E" "O" "S" even_or_odd
even_or_odd__isnull	string even_or_odd__isnull
census_block	string census_block
census_block__isnull	string census_block__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertNationalAddress

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

os_naid_hash	string or null <= 100 characters
dot_guid	string or null <= 100 characters
full_address	string or null <= 1000 characters
has_units	boolean or null
building_id	string or null <= 100 characters
address12	string or null <= 500 characters
address1	string or null <= 100 characters
address2	string or null <= 100 characters
street_number	string or null <= 20 characters
street_name	string or null <= 100 characters
building	string or null <= 100 characters
unit	string or null <= 50 characters
p_city	string or null <= 100 characters
p_state	string or null <= 2 characters
p_county	string or null <= 100 characters
p_zip_5	string or null <= 5 characters
p_zip_4	string or null <= 4 characters
country	string or null <= 500 characters
even_or_odd	string or null Enum: "E" "O" "S"
precinct_name	string or null <= 20 characters
precinct_number	string or null <= 20 characters
polling_location	string or null <= 200 characters
polling_location_address	string or null <= 200 characters
municipality	string or null <= 100 characters
ward	string or null <= 20 characters
citydistrict	string or null <= 20 characters
lower_state_leg	string or null <= 20 characters
upper_state_leg	string or null <= 20 characters
congressional	string or null <= 20 characters
raw_lat_long	string or null <= 500 characters
raw_lat	number or null
raw_long	number or null
geom	string or null
labels	Array of integers
local_door_notes	string or null <= 500 characters
census_block	integer or null

Responses

Request samples

Payload

Content type

application/json

{"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

Response samples

201

Content type

application/json

{"pk": 0,
"national_address_id": 0,
"os_naid_hash": "string",
"dot_guid": "string",
"full_address": "string",
"has_units": true,
"building_id": "string",
"address12": "string",
"address1": "string",
"address2": "string",
"street_number": "string",
"street_name": "string",
"building": "string",
"unit": "string",
"p_city": "string",
"p_state": "st",
"p_county": "string",
"p_zip_5": "strin",
"p_zip_4": "stri",
"country": "string",
"even_or_odd": "E",
"precinct_name": "string",
"precinct_number": "string",
"polling_location": "string",
"polling_location_address": "string",
"municipality": "string",
"ward": "string",
"citydistrict": "string",
"lower_state_leg": "string",
"upper_state_leg": "string",
"congressional": "string",
"raw_lat_long": "string",
"raw_lat": 0,
"raw_long": 0,
"geom": "string",
"labels": [0
],
"local_door_notes": "string",
"census_block": 0
}

occupation-affiliation-options

listOccupationAffiliationOptions

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}
]
}

createOccupationAffiliationOptions

Request Body schema:
application/json

occupation_affiliation	string or null Enum: "Teacher" "School Administrator" "School Support Staff" "Educational Employee" "Nurse" "Doctor" "Healthcare Worker" "Fisher" "Hunter" "Farmer" "Child Care Worker" "Pilot" "Flight Attendant" "Flight Mechanic" "Control Tower Operator" "Aviation Employee" "Electrical Worker" "Plumber" "Trade Worker" "Administrator" "Agricultural Worker" "Artist or Creative" "Zoning" "Education Administration" "Resources" "Legislature" "Finance" "Health and Human Services" "Criminal Justice" "Law Enforcement" "Regulatory" "Specialized Department" "Transporation" "Military" "Other Public Employee" "Public Employee" "Other"
affiliation_is_current	boolean or null
date_of_affiliation	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": 0,
"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

retrieveOccupationAffiliationOptions

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

updateOccupationAffiliationOptions

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

occupation_affiliation	string or null Enum: "Teacher" "School Administrator" "School Support Staff" "Educational Employee" "Nurse" "Doctor" "Healthcare Worker" "Fisher" "Hunter" "Farmer" "Child Care Worker" "Pilot" "Flight Attendant" "Flight Mechanic" "Control Tower Operator" "Aviation Employee" "Electrical Worker" "Plumber" "Trade Worker" "Administrator" "Agricultural Worker" "Artist or Creative" "Zoning" "Education Administration" "Resources" "Legislature" "Finance" "Health and Human Services" "Criminal Justice" "Law Enforcement" "Regulatory" "Specialized Department" "Transporation" "Military" "Other Public Employee" "Public Employee" "Other"
affiliation_is_current	boolean or null
date_of_affiliation	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

partialUpdateOccupationAffiliationOptions

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

occupation_affiliation	string or null Enum: "Teacher" "School Administrator" "School Support Staff" "Educational Employee" "Nurse" "Doctor" "Healthcare Worker" "Fisher" "Hunter" "Farmer" "Child Care Worker" "Pilot" "Flight Attendant" "Flight Mechanic" "Control Tower Operator" "Aviation Employee" "Electrical Worker" "Plumber" "Trade Worker" "Administrator" "Agricultural Worker" "Artist or Creative" "Zoning" "Education Administration" "Resources" "Legislature" "Finance" "Health and Human Services" "Criminal Justice" "Law Enforcement" "Regulatory" "Specialized Department" "Transporation" "Military" "Other Public Employee" "Public Employee" "Other"
affiliation_is_current	boolean or null
date_of_affiliation	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

destroyOccupationAffiliationOptions

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertOccupationAffiliationOptions

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

occupation_affiliation	string or null Enum: "Teacher" "School Administrator" "School Support Staff" "Educational Employee" "Nurse" "Doctor" "Healthcare Worker" "Fisher" "Hunter" "Farmer" "Child Care Worker" "Pilot" "Flight Attendant" "Flight Mechanic" "Control Tower Operator" "Aviation Employee" "Electrical Worker" "Plumber" "Trade Worker" "Administrator" "Agricultural Worker" "Artist or Creative" "Zoning" "Education Administration" "Resources" "Legislature" "Finance" "Health and Human Services" "Criminal Justice" "Law Enforcement" "Regulatory" "Specialized Department" "Transporation" "Military" "Other Public Employee" "Public Employee" "Other"
affiliation_is_current	boolean or null
date_of_affiliation	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": 0,
"occupation_affiliation": "Teacher",
"affiliation_is_current": true,
"date_of_affiliation": "2019-08-24T14:15:22Z"
}

openfield-relations

listOpenFieldRelations

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}
]
}

createOpenFieldRelation

Request Body schema:
application/json

mapping required	object
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

retrieveOpenFieldRelation

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

updateOpenFieldRelation

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

mapping required	object
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

partialUpdateOpenFieldRelation

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

mapping required	object
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

destroyOpenFieldRelation

path Parameters

id

required

string

query Parameters

resource_type	string resource_type
resource_type__isnull	string resource_type__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertOpenFieldRelation

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

mapping required	object
resource_type required	integer
resource_id required	integer [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"resource": "string",
"mapping": { },
"resource_type": 0,
"resource_id": 2147483647
}

organizations

listOrganizations

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"docs_url": "http://example.com",
"highlight_color": "string",
"id": 0,
"name": "string",
"pk": 0,
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string",
"hide_missing_data_fields": "string"
}
]
}

meOrganization

Responses

Response samples

200

Content type

application/json

{"docs_url": "http://example.com",
"highlight_color": "string",
"id": 0,
"name": "string",
"pk": 0,
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string",
"hide_missing_data_fields": "string"
}

userStatsOrganizationUserStats

Responses

Response samples

200

Content type

application/json

{"addresses": 0,
"people": 0,
"active": 0,
"staffers": 0,
"directors": 0,
"superusers": 0
}

retrieveOrganization

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"docs_url": "http://example.com",
"highlight_color": "string",
"id": 0,
"name": "string",
"pk": 0,
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string",
"hide_missing_data_fields": "string"
}

updateOrganization

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

docs_url	string <uri> <= 200 characters ^(?:[a-z0-9.+-])://(?:[^\s:@/]+(?::[^\s:@/]...
highlight_color	string <= 7 characters
name required	string <= 100 characters
primary_color	string <= 7 characters
schema_name required	string <= 63 characters
support_email	string <email> <= 254 characters
default_support_email	string <email> <= 254 characters
logo	string <binary>

Responses

Request samples

Payload

Content type

application/json

{"docs_url": "http://example.com",
"highlight_color": "string",
"name": "string",
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string"
}

Response samples

200

Content type

application/json

{"docs_url": "http://example.com",
"highlight_color": "string",
"id": 0,
"name": "string",
"pk": 0,
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string",
"hide_missing_data_fields": "string"
}

partialUpdateOrganization

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

docs_url	string <uri> <= 200 characters ^(?:[a-z0-9.+-])://(?:[^\s:@/]+(?::[^\s:@/]...
highlight_color	string <= 7 characters
name required	string <= 100 characters
primary_color	string <= 7 characters
schema_name required	string <= 63 characters
support_email	string <email> <= 254 characters
default_support_email	string <email> <= 254 characters
logo	string <binary>

Responses

Request samples

Payload

Content type

application/json

{"docs_url": "http://example.com",
"highlight_color": "string",
"name": "string",
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string"
}

Response samples

200

Content type

application/json

{"docs_url": "http://example.com",
"highlight_color": "string",
"id": 0,
"name": "string",
"pk": 0,
"primary_color": "string",
"schema_name": "string",
"support_email": "user@example.com",
"default_support_email": "user@example.com",
"logo": "string",
"hide_missing_data_fields": "string"
}

updateCompanySettingsOrganizationUserStats

path Parameters

id

required

string

Request Body schema:
application/json

addresses required	integer
people required	integer
active required	integer
staffers required	integer
directors required	integer
superusers required	integer

Responses

Request samples

Payload

Content type

application/json

{"addresses": 0,
"people": 0,
"active": 0,
"staffers": 0,
"directors": 0,
"superusers": 0
}

Response samples

200

Content type

application/json

{"addresses": 0,
"people": 0,
"active": 0,
"staffers": 0,
"directors": 0,
"superusers": 0
}

people

listPeoples

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
created_date	string created_date
created_date__gte	string created_date__gte
created_date__lte	string created_date__lte
created_date__isnull	string created_date__isnull
vr_status	string Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered" vr_status
vr_status__isnull	string vr_status__isnull
phone_opt_in1	string phone_opt_in1
phone_opt_in1__isnull	string phone_opt_in1__isnull
phone_opt_in2	string phone_opt_in2
phone_opt_in2__isnull	string phone_opt_in2__isnull
email_opt_in1	string email_opt_in1
email_opt_in1__isnull	string email_opt_in1__isnull
email_opt_in2	string email_opt_in2
email_opt_in2__isnull	string email_opt_in2__isnull
provided_national_address_id	string provided_national_address_id
provided_national_address_id__isnull	string provided_national_address_id__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
registered_national_address_id	string registered_national_address_id
registered_national_address_id__isnull	string registered_national_address_id__isnull
mailing_national_address_id	string mailing_national_address_id
mailing_national_address_id__isnull	string mailing_national_address_id__isnull
early_voted	string early_voted
early_voted__isnull	string early_voted__isnull
conversations__conversation_code	string conversations__conversation_code
conversations__conversation_code__isnull	string conversations__conversation_code__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}
]
}

createPeople

Request Body schema:
application/json

state_file_id	string or null <= 50 characters
county_file_id	string or null <= 50 characters
van_id	string or null <= 50 characters
my_campaign_id	string or null <= 100 characters
mobilize_id	string or null <= 50 characters
actionkit_id	string or null <= 50 characters
action_network_id	string or null <= 50 characters
of_voter_file_id	string or null <= 50 characters
other_voter_file_id	string or null <= 50 characters
alloy_uuid	string or null <= 100 characters
vr_status	string or null Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered"
full_name	string or null <= 500 characters
honorarium	string or null <= 10 characters
first_name required	string <= 100 characters
middle_name	string or null <= 100 characters
last_name required	string <= 100 characters
suffix	string or null <= 20 characters
preferred_name	string or null <= 100 characters
sex	string or null <= 20 characters
age	integer or null [ -2147483648 .. 2147483647 ]
dob	string or null <date>
gender_identity	string or null <= 20 characters
pronouns	Array of integers
languages_spoken	Array of integers
phone1	string or null <= 128 characters
phone_opt_in1	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
phone2	string or null <= 128 characters
phone_opt_in2	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
email1	string or null <email> <= 254 characters
email_opt_in1	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
email2	string or null <email> <= 254 characters
email_opt_in2	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
provided_national_address_id	integer or null
prov_full_address	string or null <= 1000 characters
prov_address1	string or null <= 100 characters
prov_address2	string or null <= 100 characters
prov_city	string or null <= 100 characters
prov_state	string or null <= 2 characters
prov_zip_5	string or null <= 5 characters
p_raw_lat_long	string or null <= 500 characters
p_raw_lat	number or null
p_raw_long	number or null
p_geom	string or null
contacted_national_address_id	integer or null
contacted_full_address	string or null <= 1000 characters
lives_at_contacted	boolean or null
registered_national_address_id	integer or null
reg_full_address	string or null <= 1000 characters
reg_address1	string or null <= 100 characters
reg_address2	string or null <= 100 characters
reg_city	string or null <= 100 characters
reg_county	string or null <= 100 characters
reg_state	string or null <= 2 characters
reg_zip_5	string or null <= 5 characters
r_raw_lat_long	string or null <= 500 characters
r_raw_lat	number or null
r_raw_long	number or null
r_geom	string or null
mailing_national_address_id	integer or null
mail_full_address	string or null <= 1000 characters
mail_address1	string or null <= 100 characters
mail_address2	string or null <= 100 characters
mail_city	string or null <= 100 characters
mail_state	string or null <= 2 characters
mail_zip_5	string or null <= 5 characters
m_raw_lat_long	string or null <= 500 characters
m_raw_lat	number or null
m_raw_long	number or null
m_geom	string or null
early_voted	boolean or null
contact_matches	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"contact_matches": [0
]
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}

retrievePeople

path Parameters

id

required

string

query Parameters

created_date	string created_date
created_date__gte	string created_date__gte
created_date__lte	string created_date__lte
created_date__isnull	string created_date__isnull
vr_status	string Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered" vr_status
vr_status__isnull	string vr_status__isnull
phone_opt_in1	string phone_opt_in1
phone_opt_in1__isnull	string phone_opt_in1__isnull
phone_opt_in2	string phone_opt_in2
phone_opt_in2__isnull	string phone_opt_in2__isnull
email_opt_in1	string email_opt_in1
email_opt_in1__isnull	string email_opt_in1__isnull
email_opt_in2	string email_opt_in2
email_opt_in2__isnull	string email_opt_in2__isnull
provided_national_address_id	string provided_national_address_id
provided_national_address_id__isnull	string provided_national_address_id__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
registered_national_address_id	string registered_national_address_id
registered_national_address_id__isnull	string registered_national_address_id__isnull
mailing_national_address_id	string mailing_national_address_id
mailing_national_address_id__isnull	string mailing_national_address_id__isnull
early_voted	string early_voted
early_voted__isnull	string early_voted__isnull
conversations__conversation_code	string conversations__conversation_code
conversations__conversation_code__isnull	string conversations__conversation_code__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}

updatePeople

path Parameters

id

required

string

query Parameters

created_date	string created_date
created_date__gte	string created_date__gte
created_date__lte	string created_date__lte
created_date__isnull	string created_date__isnull
vr_status	string Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered" vr_status
vr_status__isnull	string vr_status__isnull
phone_opt_in1	string phone_opt_in1
phone_opt_in1__isnull	string phone_opt_in1__isnull
phone_opt_in2	string phone_opt_in2
phone_opt_in2__isnull	string phone_opt_in2__isnull
email_opt_in1	string email_opt_in1
email_opt_in1__isnull	string email_opt_in1__isnull
email_opt_in2	string email_opt_in2
email_opt_in2__isnull	string email_opt_in2__isnull
provided_national_address_id	string provided_national_address_id
provided_national_address_id__isnull	string provided_national_address_id__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
registered_national_address_id	string registered_national_address_id
registered_national_address_id__isnull	string registered_national_address_id__isnull
mailing_national_address_id	string mailing_national_address_id
mailing_national_address_id__isnull	string mailing_national_address_id__isnull
early_voted	string early_voted
early_voted__isnull	string early_voted__isnull
conversations__conversation_code	string conversations__conversation_code
conversations__conversation_code__isnull	string conversations__conversation_code__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

state_file_id	string or null <= 50 characters
county_file_id	string or null <= 50 characters
van_id	string or null <= 50 characters
my_campaign_id	string or null <= 100 characters
mobilize_id	string or null <= 50 characters
actionkit_id	string or null <= 50 characters
action_network_id	string or null <= 50 characters
of_voter_file_id	string or null <= 50 characters
other_voter_file_id	string or null <= 50 characters
alloy_uuid	string or null <= 100 characters
vr_status	string or null Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered"
full_name	string or null <= 500 characters
honorarium	string or null <= 10 characters
first_name required	string <= 100 characters
middle_name	string or null <= 100 characters
last_name required	string <= 100 characters
suffix	string or null <= 20 characters
preferred_name	string or null <= 100 characters
sex	string or null <= 20 characters
age	integer or null [ -2147483648 .. 2147483647 ]
dob	string or null <date>
gender_identity	string or null <= 20 characters
pronouns	Array of integers
languages_spoken	Array of integers
phone1	string or null <= 128 characters
phone_opt_in1	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
phone2	string or null <= 128 characters
phone_opt_in2	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
email1	string or null <email> <= 254 characters
email_opt_in1	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
email2	string or null <email> <= 254 characters
email_opt_in2	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
provided_national_address_id	integer or null
prov_full_address	string or null <= 1000 characters
prov_address1	string or null <= 100 characters
prov_address2	string or null <= 100 characters
prov_city	string or null <= 100 characters
prov_state	string or null <= 2 characters
prov_zip_5	string or null <= 5 characters
p_raw_lat_long	string or null <= 500 characters
p_raw_lat	number or null
p_raw_long	number or null
p_geom	string or null
contacted_national_address_id	integer or null
contacted_full_address	string or null <= 1000 characters
lives_at_contacted	boolean or null
registered_national_address_id	integer or null
reg_full_address	string or null <= 1000 characters
reg_address1	string or null <= 100 characters
reg_address2	string or null <= 100 characters
reg_city	string or null <= 100 characters
reg_county	string or null <= 100 characters
reg_state	string or null <= 2 characters
reg_zip_5	string or null <= 5 characters
r_raw_lat_long	string or null <= 500 characters
r_raw_lat	number or null
r_raw_long	number or null
r_geom	string or null
mailing_national_address_id	integer or null
mail_full_address	string or null <= 1000 characters
mail_address1	string or null <= 100 characters
mail_address2	string or null <= 100 characters
mail_city	string or null <= 100 characters
mail_state	string or null <= 2 characters
mail_zip_5	string or null <= 5 characters
m_raw_lat_long	string or null <= 500 characters
m_raw_lat	number or null
m_raw_long	number or null
m_geom	string or null
early_voted	boolean or null
contact_matches	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"contact_matches": [0
]
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}

partialUpdatePeople

path Parameters

id

required

string

query Parameters

created_date	string created_date
created_date__gte	string created_date__gte
created_date__lte	string created_date__lte
created_date__isnull	string created_date__isnull
vr_status	string Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered" vr_status
vr_status__isnull	string vr_status__isnull
phone_opt_in1	string phone_opt_in1
phone_opt_in1__isnull	string phone_opt_in1__isnull
phone_opt_in2	string phone_opt_in2
phone_opt_in2__isnull	string phone_opt_in2__isnull
email_opt_in1	string email_opt_in1
email_opt_in1__isnull	string email_opt_in1__isnull
email_opt_in2	string email_opt_in2
email_opt_in2__isnull	string email_opt_in2__isnull
provided_national_address_id	string provided_national_address_id
provided_national_address_id__isnull	string provided_national_address_id__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
registered_national_address_id	string registered_national_address_id
registered_national_address_id__isnull	string registered_national_address_id__isnull
mailing_national_address_id	string mailing_national_address_id
mailing_national_address_id__isnull	string mailing_national_address_id__isnull
early_voted	string early_voted
early_voted__isnull	string early_voted__isnull
conversations__conversation_code	string conversations__conversation_code
conversations__conversation_code__isnull	string conversations__conversation_code__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

state_file_id	string or null <= 50 characters
county_file_id	string or null <= 50 characters
van_id	string or null <= 50 characters
my_campaign_id	string or null <= 100 characters
mobilize_id	string or null <= 50 characters
actionkit_id	string or null <= 50 characters
action_network_id	string or null <= 50 characters
of_voter_file_id	string or null <= 50 characters
other_voter_file_id	string or null <= 50 characters
alloy_uuid	string or null <= 100 characters
vr_status	string or null Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered"
full_name	string or null <= 500 characters
honorarium	string or null <= 10 characters
first_name required	string <= 100 characters
middle_name	string or null <= 100 characters
last_name required	string <= 100 characters
suffix	string or null <= 20 characters
preferred_name	string or null <= 100 characters
sex	string or null <= 20 characters
age	integer or null [ -2147483648 .. 2147483647 ]
dob	string or null <date>
gender_identity	string or null <= 20 characters
pronouns	Array of integers
languages_spoken	Array of integers
phone1	string or null <= 128 characters
phone_opt_in1	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
phone2	string or null <= 128 characters
phone_opt_in2	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
email1	string or null <email> <= 254 characters
email_opt_in1	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
email2	string or null <email> <= 254 characters
email_opt_in2	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
provided_national_address_id	integer or null
prov_full_address	string or null <= 1000 characters
prov_address1	string or null <= 100 characters
prov_address2	string or null <= 100 characters
prov_city	string or null <= 100 characters
prov_state	string or null <= 2 characters
prov_zip_5	string or null <= 5 characters
p_raw_lat_long	string or null <= 500 characters
p_raw_lat	number or null
p_raw_long	number or null
p_geom	string or null
contacted_national_address_id	integer or null
contacted_full_address	string or null <= 1000 characters
lives_at_contacted	boolean or null
registered_national_address_id	integer or null
reg_full_address	string or null <= 1000 characters
reg_address1	string or null <= 100 characters
reg_address2	string or null <= 100 characters
reg_city	string or null <= 100 characters
reg_county	string or null <= 100 characters
reg_state	string or null <= 2 characters
reg_zip_5	string or null <= 5 characters
r_raw_lat_long	string or null <= 500 characters
r_raw_lat	number or null
r_raw_long	number or null
r_geom	string or null
mailing_national_address_id	integer or null
mail_full_address	string or null <= 1000 characters
mail_address1	string or null <= 100 characters
mail_address2	string or null <= 100 characters
mail_city	string or null <= 100 characters
mail_state	string or null <= 2 characters
mail_zip_5	string or null <= 5 characters
m_raw_lat_long	string or null <= 500 characters
m_raw_lat	number or null
m_raw_long	number or null
m_geom	string or null
early_voted	boolean or null
contact_matches	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"contact_matches": [0
]
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}

destroyPeople

path Parameters

id

required

string

query Parameters

created_date	string created_date
created_date__gte	string created_date__gte
created_date__lte	string created_date__lte
created_date__isnull	string created_date__isnull
vr_status	string Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered" vr_status
vr_status__isnull	string vr_status__isnull
phone_opt_in1	string phone_opt_in1
phone_opt_in1__isnull	string phone_opt_in1__isnull
phone_opt_in2	string phone_opt_in2
phone_opt_in2__isnull	string phone_opt_in2__isnull
email_opt_in1	string email_opt_in1
email_opt_in1__isnull	string email_opt_in1__isnull
email_opt_in2	string email_opt_in2
email_opt_in2__isnull	string email_opt_in2__isnull
provided_national_address_id	string provided_national_address_id
provided_national_address_id__isnull	string provided_national_address_id__isnull
contacted_national_address_id	string contacted_national_address_id
contacted_national_address_id__isnull	string contacted_national_address_id__isnull
registered_national_address_id	string registered_national_address_id
registered_national_address_id__isnull	string registered_national_address_id__isnull
mailing_national_address_id	string mailing_national_address_id
mailing_national_address_id__isnull	string mailing_national_address_id__isnull
early_voted	string early_voted
early_voted__isnull	string early_voted__isnull
conversations__conversation_code	string conversations__conversation_code
conversations__conversation_code__isnull	string conversations__conversation_code__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertPeople

Given a list of objects, tries the match the object with ['id', ('county_file_id', 'state_file_id')]. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

state_file_id	string or null <= 50 characters
county_file_id	string or null <= 50 characters
van_id	string or null <= 50 characters
my_campaign_id	string or null <= 100 characters
mobilize_id	string or null <= 50 characters
actionkit_id	string or null <= 50 characters
action_network_id	string or null <= 50 characters
of_voter_file_id	string or null <= 50 characters
other_voter_file_id	string or null <= 50 characters
alloy_uuid	string or null <= 100 characters
vr_status	string or null Enum: "OF Form Submitted" "OF Form Mailed" "OF Form Arrived" "OF Return Mailed" "Active" "Challenged" "Not Eligible" "Denied" "Inactive" "Pending" "Confirmation" "Removed" "Preregistered" "Rejected" "Unregistered" "Verify" "Cancelled" "Incomplete" "Purged" "Registered"
full_name	string or null <= 500 characters
honorarium	string or null <= 10 characters
first_name required	string <= 100 characters
middle_name	string or null <= 100 characters
last_name required	string <= 100 characters
suffix	string or null <= 20 characters
preferred_name	string or null <= 100 characters
sex	string or null <= 20 characters
age	integer or null [ -2147483648 .. 2147483647 ]
dob	string or null <date>
gender_identity	string or null <= 20 characters
pronouns	Array of integers
languages_spoken	Array of integers
phone1	string or null <= 128 characters
phone_opt_in1	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
phone2	string or null <= 128 characters
phone_opt_in2	boolean or null By providing your phone number you consent to receive phone and text communications from this organization concerning news, action opportunities, and other important information.
email1	string or null <email> <= 254 characters
email_opt_in1	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
email2	string or null <email> <= 254 characters
email_opt_in2	boolean or null By providing your email you consent to receive email communications from this organization concerning news, action opportunities, and other important information.
provided_national_address_id	integer or null
prov_full_address	string or null <= 1000 characters
prov_address1	string or null <= 100 characters
prov_address2	string or null <= 100 characters
prov_city	string or null <= 100 characters
prov_state	string or null <= 2 characters
prov_zip_5	string or null <= 5 characters
p_raw_lat_long	string or null <= 500 characters
p_raw_lat	number or null
p_raw_long	number or null
p_geom	string or null
contacted_national_address_id	integer or null
contacted_full_address	string or null <= 1000 characters
lives_at_contacted	boolean or null
registered_national_address_id	integer or null
reg_full_address	string or null <= 1000 characters
reg_address1	string or null <= 100 characters
reg_address2	string or null <= 100 characters
reg_city	string or null <= 100 characters
reg_county	string or null <= 100 characters
reg_state	string or null <= 2 characters
reg_zip_5	string or null <= 5 characters
r_raw_lat_long	string or null <= 500 characters
r_raw_lat	number or null
r_raw_long	number or null
r_geom	string or null
mailing_national_address_id	integer or null
mail_full_address	string or null <= 1000 characters
mail_address1	string or null <= 100 characters
mail_address2	string or null <= 100 characters
mail_city	string or null <= 100 characters
mail_state	string or null <= 2 characters
mail_zip_5	string or null <= 5 characters
m_raw_lat_long	string or null <= 500 characters
m_raw_lat	number or null
m_raw_long	number or null
m_geom	string or null
early_voted	boolean or null
contact_matches	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"contact_matches": [0
]
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}

phones

listPhones

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"phone": "string",
"status": "UNK",
"status_time": "2019-08-24T14:15:22Z",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}
]
}

createPhone

Request Body schema:
application/json

phone required	string <= 128 characters
status	string or null Enum: "UNK" "AC" "RF" "DNC" "DIS" "HS" "FX" "WN"
dnc_registered	boolean or null
phone_designation	string or null Enum: "Cell" "Landline" "Mixed" "Unknown"
connectivity_score	integer or null [ -2147483648 .. 2147483647 ]
person	integer or null
labels	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"phone": "string",
"status": "UNK",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

Response samples

201

Content type

application/json

{"id": 0,
"phone": "string",
"status": "UNK",
"status_time": "2019-08-24T14:15:22Z",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

retrievePhone

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"phone": "string",
"status": "UNK",
"status_time": "2019-08-24T14:15:22Z",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

updatePhone

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

phone required	string <= 128 characters
status	string or null Enum: "UNK" "AC" "RF" "DNC" "DIS" "HS" "FX" "WN"
dnc_registered	boolean or null
phone_designation	string or null Enum: "Cell" "Landline" "Mixed" "Unknown"
connectivity_score	integer or null [ -2147483648 .. 2147483647 ]
person	integer or null
labels	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"phone": "string",
"status": "UNK",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"phone": "string",
"status": "UNK",
"status_time": "2019-08-24T14:15:22Z",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

partialUpdatePhone

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

phone required	string <= 128 characters
status	string or null Enum: "UNK" "AC" "RF" "DNC" "DIS" "HS" "FX" "WN"
dnc_registered	boolean or null
phone_designation	string or null Enum: "Cell" "Landline" "Mixed" "Unknown"
connectivity_score	integer or null [ -2147483648 .. 2147483647 ]
person	integer or null
labels	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"phone": "string",
"status": "UNK",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"phone": "string",
"status": "UNK",
"status_time": "2019-08-24T14:15:22Z",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

destroyPhone

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertPhone

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

phone required	string <= 128 characters
status	string or null Enum: "UNK" "AC" "RF" "DNC" "DIS" "HS" "FX" "WN"
dnc_registered	boolean or null
phone_designation	string or null Enum: "Cell" "Landline" "Mixed" "Unknown"
connectivity_score	integer or null [ -2147483648 .. 2147483647 ]
person	integer or null
labels	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"phone": "string",
"status": "UNK",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

Response samples

201

Content type

application/json

{"id": 0,
"phone": "string",
"status": "UNK",
"status_time": "2019-08-24T14:15:22Z",
"dnc_registered": true,
"phone_designation": "Cell",
"connectivity_score": -2147483648,
"person": 0,
"labels": [0
]
}

pronouns

listPronouns

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string",
"display": "string"
}
]
}

createPronoun

Request Body schema:
application/json

subj_pronoun required	string <= 255 characters subjective pronoun, ie: X laughed at the notion of a gender binary.
obj_pronoun required	string <= 255 characters objective pronoun, ie: We tried to convince X that the gender binary was a construct.
poss_pronoun required	string <= 255 characters possessive pronoun, ie: X favorite color is the inclusive rainbow.

Responses

Request samples

Payload

Content type

application/json

{"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string",
"display": "string"
}

retrievePronoun

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string",
"display": "string"
}

updatePronoun

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

subj_pronoun required	string <= 255 characters subjective pronoun, ie: X laughed at the notion of a gender binary.
obj_pronoun required	string <= 255 characters objective pronoun, ie: We tried to convince X that the gender binary was a construct.
poss_pronoun required	string <= 255 characters possessive pronoun, ie: X favorite color is the inclusive rainbow.

Responses

Request samples

Payload

Content type

application/json

{"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string",
"display": "string"
}

partialUpdatePronoun

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

subj_pronoun required	string <= 255 characters subjective pronoun, ie: X laughed at the notion of a gender binary.
obj_pronoun required	string <= 255 characters objective pronoun, ie: We tried to convince X that the gender binary was a construct.
poss_pronoun required	string <= 255 characters possessive pronoun, ie: X favorite color is the inclusive rainbow.

Responses

Request samples

Payload

Content type

application/json

{"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string",
"display": "string"
}

destroyPronoun

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertPronoun

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

subj_pronoun required	string <= 255 characters subjective pronoun, ie: X laughed at the notion of a gender binary.
obj_pronoun required	string <= 255 characters objective pronoun, ie: We tried to convince X that the gender binary was a construct.
poss_pronoun required	string <= 255 characters possessive pronoun, ie: X favorite color is the inclusive rainbow.

Responses

Request samples

Payload

Content type

application/json

{"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"subj_pronoun": "string",
"obj_pronoun": "string",
"poss_pronoun": "string",
"display": "string"
}

questions

listQuestionsPolymorphics

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
polymorphic_ctype	string polymorphic_ctype
polymorphic_ctype__isnull	string polymorphic_ctype__isnull
question_template	string question_template
question_template__isnull	string question_template__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{ }
]
}

createQuestionsPolymorphic

Request Body schema:
application/json

object (QuestionsPolymorphic)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

retrieveQuestionsPolymorphic

path Parameters

id

required

string

query Parameters

polymorphic_ctype	string polymorphic_ctype
polymorphic_ctype__isnull	string polymorphic_ctype__isnull
question_template	string question_template
question_template__isnull	string question_template__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{ }

updateQuestionsPolymorphic

path Parameters

id

required

string

query Parameters

polymorphic_ctype	string polymorphic_ctype
polymorphic_ctype__isnull	string polymorphic_ctype__isnull
question_template	string question_template
question_template__isnull	string question_template__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

object (QuestionsPolymorphic)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

partialUpdateQuestionsPolymorphic

path Parameters

id

required

string

query Parameters

polymorphic_ctype	string polymorphic_ctype
polymorphic_ctype__isnull	string polymorphic_ctype__isnull
question_template	string question_template
question_template__isnull	string question_template__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

object (QuestionsPolymorphic)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

destroyQuestionsPolymorphic

path Parameters

id

required

string

query Parameters

polymorphic_ctype	string polymorphic_ctype
polymorphic_ctype__isnull	string polymorphic_ctype__isnull
question_template	string question_template
question_template__isnull	string question_template__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertQuestionsPolymorphic

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

object (QuestionsPolymorphic)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

script-questions

listScriptQuestions

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
script	string script
script__isnull	string script__isnull
question	string question
question__isnull	string question__isnull
question__question_template	string question__question_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}
]
}

createScriptQuestion

Request Body schema:
application/json

script required	integer
question required	integer
q_order	integer or null [ -2147483648 .. 2147483647 ]
is_required	boolean

Responses

Request samples

Payload

Content type

application/json

{"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

retrieveScriptQuestion

path Parameters

id

required

string

query Parameters

script	string script
script__isnull	string script__isnull
question	string question
question__isnull	string question__isnull
question__question_template	string question__question_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

updateScriptQuestion

path Parameters

id

required

string

query Parameters

script	string script
script__isnull	string script__isnull
question	string question
question__isnull	string question__isnull
question__question_template	string question__question_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

script required	integer
question required	integer
q_order	integer or null [ -2147483648 .. 2147483647 ]
is_required	boolean

Responses

Request samples

Payload

Content type

application/json

{"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

partialUpdateScriptQuestion

path Parameters

id

required

string

query Parameters

script	string script
script__isnull	string script__isnull
question	string question
question__isnull	string question__isnull
question__question_template	string question__question_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

script required	integer
question required	integer
q_order	integer or null [ -2147483648 .. 2147483647 ]
is_required	boolean

Responses

Request samples

Payload

Content type

application/json

{"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

destroyScriptQuestion

path Parameters

id

required

string

query Parameters

script	string script
script__isnull	string script__isnull
question	string question
question__isnull	string question__isnull
question__question_template	string question__question_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertScriptQuestion

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

script required	integer
question required	integer
q_order	integer or null [ -2147483648 .. 2147483647 ]
is_required	boolean

Responses

Request samples

Payload

Content type

application/json

{"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"script": 0,
"question": 0,
"q_order": -2147483648,
"is_required": true
}

scripts

listScripts

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"display": "string",
"name": "string",
"description": "string",
"s_questions": ["string"
],
"default_text": "string"
}
]
}

createScript

Request Body schema:
application/json

name required	string <= 255 characters
description	string
default_text	string or null <= 1000 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"default_text": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"display": "string",
"name": "string",
"description": "string",
"s_questions": ["string"
],
"default_text": "string"
}

retrieveScript

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"display": "string",
"name": "string",
"description": "string",
"s_questions": ["string"
],
"default_text": "string"
}

updateScript

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 255 characters
description	string
default_text	string or null <= 1000 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"default_text": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"display": "string",
"name": "string",
"description": "string",
"s_questions": ["string"
],
"default_text": "string"
}

partialUpdateScript

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name required	string <= 255 characters
description	string
default_text	string or null <= 1000 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"default_text": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"display": "string",
"name": "string",
"description": "string",
"s_questions": ["string"
],
"default_text": "string"
}

destroyScript

path Parameters

id

required

string

query Parameters

created_at	string created_at
created_at__gte	string created_at__gte
created_at__lte	string created_at__lte
created_at__isnull	string created_at__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertScript

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

name required	string <= 255 characters
description	string
default_text	string or null <= 1000 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"default_text": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"display": "string",
"name": "string",
"description": "string",
"s_questions": ["string"
],
"default_text": "string"
}

script-leaderboard

listScriptLeaderboards

query Parameters

page	integer A page number within the paginated result set.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"description": "string",
"attempts": 0,
"contacts": 0
}
]
}

createScriptLeaderboard

Request Body schema:
application/json

description	string
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"description": "string",
"attempts": 0,
"contacts": 0
}

retrieveScriptLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"description": "string",
"attempts": 0,
"contacts": 0
}

updateScriptLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

description	string
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"description": "string",
"attempts": 0,
"contacts": 0
}

partialUpdateScriptLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

description	string
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"description": "string",
"attempts": 0,
"contacts": 0
}

destroyScriptLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertScriptLeaderboard

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

description	string
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attempts": 0,
"contacts": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"description": "string",
"attempts": 0,
"contacts": 0
}

state-counties

listStateCountys

query Parameters

page	integer A page number within the paginated result set.
state	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AE" "AE" "AE" "AP" "AA" state
state__isnull	string state__isnull
county	string county
county__isnull	string county__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"state": "AL",
"county": "string"
}
]
}

createStateCounty

Request Body schema:
application/json

state required	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AP" "AA"
county required	string <= 100 characters

Responses

Request samples

Payload

Content type

application/json

{"state": "AL",
"county": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"state": "AL",
"county": "string"
}

retrieveStateCounty

path Parameters

id

required

string

query Parameters

state	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AE" "AE" "AE" "AP" "AA" state
state__isnull	string state__isnull
county	string county
county__isnull	string county__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"state": "AL",
"county": "string"
}

updateStateCounty

path Parameters

id

required

string

query Parameters

state	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AE" "AE" "AE" "AP" "AA" state
state__isnull	string state__isnull
county	string county
county__isnull	string county__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

state required	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AP" "AA"
county required	string <= 100 characters

Responses

Request samples

Payload

Content type

application/json

{"state": "AL",
"county": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"state": "AL",
"county": "string"
}

partialUpdateStateCounty

path Parameters

id

required

string

query Parameters

state	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AE" "AE" "AE" "AP" "AA" state
state__isnull	string state__isnull
county	string county
county__isnull	string county__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

state required	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AP" "AA"
county required	string <= 100 characters

Responses

Request samples

Payload

Content type

application/json

{"state": "AL",
"county": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"state": "AL",
"county": "string"
}

destroyStateCounty

path Parameters

id

required

string

query Parameters

state	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AE" "AE" "AE" "AP" "AA" state
state__isnull	string state__isnull
county	string county
county__isnull	string county__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertStateCounty

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

state required	string Enum: "AL" "AK" "AS" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FM" "FL" "GA" "GU" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MH" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "MP" "OH" "OK" "OR" "PW" "PA" "PR" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VI" "VA" "WA" "WV" "WI" "WY" "AE" "AP" "AA"
county required	string <= 100 characters

Responses

Request samples

Payload

Content type

application/json

{"state": "AL",
"county": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"state": "AL",
"county": "string"
}

target-list-step-input

listTargetListStepInputs

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
target_list	string target_list
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}
]
}

createTargetListStepInput

Request Body schema:
application/json

user_input	object or null
description	string or null
step_type	string Enum: "ADD" "NARROW" "REMOVE"
querying	string Enum: "people" "phones" "doors"
target_list	integer or null
list_filter	integer or null

Responses

Request samples

Payload

Content type

application/json

{"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

retrieveTargetListStepInput

path Parameters

id

required

string

query Parameters

target_list	string target_list
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

updateTargetListStepInput

path Parameters

id

required

string

query Parameters

target_list	string target_list
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

user_input	object or null
description	string or null
step_type	string Enum: "ADD" "NARROW" "REMOVE"
querying	string Enum: "people" "phones" "doors"
target_list	integer or null
list_filter	integer or null

Responses

Request samples

Payload

Content type

application/json

{"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

partialUpdateTargetListStepInput

path Parameters

id

required

string

query Parameters

target_list	string target_list
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

user_input	object or null
description	string or null
step_type	string Enum: "ADD" "NARROW" "REMOVE"
querying	string Enum: "people" "phones" "doors"
target_list	integer or null
list_filter	integer or null

Responses

Request samples

Payload

Content type

application/json

{"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

destroyTargetListStepInput

path Parameters

id

required

string

query Parameters

target_list	string target_list
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertTargetListStepInput

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

user_input	object or null
description	string or null
step_type	string Enum: "ADD" "NARROW" "REMOVE"
querying	string Enum: "people" "phones" "doors"
target_list	integer or null
list_filter	integer or null

Responses

Request samples

Payload

Content type

application/json

{"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"user_input": { },
"description": "string",
"step_type": "ADD",
"querying": "people",
"target_list": 0,
"list_filter": 0
}

target-lists

listTargetLists

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}
]
}

createTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

retrieveTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

updateTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

partialUpdateTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

destroyTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

countTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

geojsonTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

getAggregationResultTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id required	string
aggregation_id required	string

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

labelTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

labelTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

peoplePeople

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"created_date": "2019-08-24T14:15:22Z",
"state_file_id": "string",
"county_file_id": "string",
"van_id": "string",
"my_campaign_id": "string",
"mobilize_id": "string",
"actionkit_id": "string",
"action_network_id": "string",
"of_voter_file_id": "string",
"other_voter_file_id": "string",
"alloy_uuid": "string",
"vr_status": "OF Form Submitted",
"full_name": "string",
"honorarium": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"suffix": "string",
"preferred_name": "string",
"sex": "string",
"age": -2147483648,
"display": "string",
"dob": "2019-08-24",
"gender_identity": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"phone1": "string",
"phone_opt_in1": true,
"phone2": "string",
"phone_opt_in2": true,
"email1": "user@example.com",
"email_opt_in1": true,
"email2": "user@example.com",
"email_opt_in2": true,
"provided_national_address_id": 0,
"prov_full_address": "string",
"prov_address1": "string",
"prov_address2": "string",
"prov_city": "string",
"prov_state": "st",
"prov_zip_5": "strin",
"p_raw_lat_long": "string",
"p_raw_lat": 0,
"p_raw_long": 0,
"p_geom": "string",
"contacted_national_address_id": 0,
"contacted_full_address": "string",
"lives_at_contacted": true,
"registered_national_address_id": 0,
"reg_full_address": "string",
"reg_address1": "string",
"reg_address2": "string",
"reg_city": "string",
"reg_county": "string",
"reg_state": "st",
"reg_zip_5": "strin",
"r_raw_lat_long": "string",
"r_raw_lat": 0,
"r_raw_long": 0,
"r_geom": "string",
"mailing_national_address_id": 0,
"mail_full_address": "string",
"mail_address1": "string",
"mail_address2": "string",
"mail_city": "string",
"mail_state": "st",
"mail_zip_5": "strin",
"m_raw_lat_long": "string",
"m_raw_lat": 0,
"m_raw_long": 0,
"m_geom": "string",
"early_voted": true,
"labels": ["string"
],
"contact_matches": [0
]
}

bulkUpsertTargetList

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

createTargetListAndListFiltersAndListItemsTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

runQueryTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

startAggregationTaskTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

updateTargetListAndListFiltersAndListItemsTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

updateTargetListMetaDataTargetList

Similar to the TargetList ORM instructions to create a target list, we go through three steps in the api. 1 - Create a target list 2 - Create the list filters 3 - Create list filter items for list filters

1: Create a target list Send a post request to the endpoint with the name of the target list Endpoint: /api/v1/target_lists/ Request Method: POST Body: {"name": "25 years old Californians"} Response: { "pk": 10, "id": 10, "name": "25 years old Californians", "human_readable_representation": "<TargetList: None>", "count_of_people": 0 } We will use the pk of the target list to create the list filters 2: Create the list filters Create a list filter with the connector and the target list, the connector can be AND or OR and it describes how the list filter items will be combined. Endpoint: /api/v1/list-filters/ Request Method: POST Body: { "name": "25 years old Californians", "connector": "AND", "target_list": 10 } // 10 is the pk of the target list we created in step 1 Response: { "pk": 20, "id": 20, "name": "25 years old Californians", "connector": "AND", "is_negated": false, "list_filter": null, "target_list": 10, "human_readable_representation": "()" } // human_readable_representation is empty because we haven't created any list filter items yet We will use the pk of the list filter to create the list filter items 3: Create list filter items for list filters Create the list filter items for the list filter, in this case we will create 2 of them 25 years old filter, and Californian filter

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "25 years old",
    "list_filter": 20,
    "field": "age",
    "lookup": "EXACT",
    "value": "25",
    "value_type": "INT"
}
// 20 is the pk of the list filter we created in step 2

Endpoint: /api/v1/list-filter-items/
Request Method: POST
Body: {
    "name": "Californian",
    "list_filter": 20,
    "field": "vb__tsmart_state",
    "lookup": "EXACT",
    "value": "CA",
    "value_type": "STR"
}
// 20 is the pk of the list filter we created in step 2

Now if we go back to the target list we created in step 1, we can actually get the people that match the filters

4: Get the people that match the filters Endpoint: /api/v1/target_lists/10/people/ Request Method: GET // 10 is the pk of the target list we created in step 1

path Parameters

id

required

string

Request Body schema:
application/json

name

required

string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"name": "string",
"human_readable_representation": "string",
"count_of_people": 0
}

users

listUsers

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
date_joined	string date_joined
date_joined__gte	string date_joined__gte
date_joined__lte	string date_joined__lte
date_joined__isnull	string date_joined__isnull
is_paid_canvasser	string is_paid_canvasser
is_paid_canvasser__isnull	string is_paid_canvasser__isnull
is_field_director	string is_field_director
is_field_director__isnull	string is_field_director__isnull
is_staffer	string is_staffer
is_staffer__isnull	string is_staffer__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"pk": 0,
"id": 0,
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"zip_code": "strin",
"is_paid_canvasser": true,
"is_active": true,
"is_staff": true,
"is_field_director": true,
"is_staffer": true,
"date_joined": "2019-08-24T14:15:22Z",
"cell_phone": "string",
"display": "string"
}
]
}

retrieveUser

path Parameters

id

required

string

query Parameters

date_joined	string date_joined
date_joined__gte	string date_joined__gte
date_joined__lte	string date_joined__lte
date_joined__isnull	string date_joined__isnull
is_paid_canvasser	string is_paid_canvasser
is_paid_canvasser__isnull	string is_paid_canvasser__isnull
is_field_director	string is_field_director
is_field_director__isnull	string is_field_director__isnull
is_staffer	string is_staffer
is_staffer__isnull	string is_staffer__isnull
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"pk": 0,
"id": 0,
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"pronouns": [0
],
"languages_spoken": [0
],
"zip_code": "strin",
"is_paid_canvasser": true,
"is_active": true,
"is_staff": true,
"is_field_director": true,
"is_staffer": true,
"date_joined": "2019-08-24T14:15:22Z",
"cell_phone": "string",
"display": "string"
}

user-leaderboard

listUserLeaderboards

query Parameters

page	integer A page number within the paginated result set.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}
]
}

createUserLeaderboard

Request Body schema:
application/json

first_name required	string <= 128 characters
last_name required	string <= 128 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

Response samples

201

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

retrieveUserLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

updateUserLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

first_name required	string <= 128 characters
last_name required	string <= 128 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

Response samples

200

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

partialUpdateUserLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

first_name required	string <= 128 characters
last_name required	string <= 128 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

Response samples

200

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

destroyUserLeaderboard

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertUserLeaderboard

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

first_name required	string <= 128 characters
last_name required	string <= 128 characters
attempts required	integer
contacts required	integer

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

Response samples

201

Content type

application/json

{"first_name": "string",
"last_name": "string",
"attempts": 0,
"contacts": 0
}

user-autocomplete

listUserAutocompletes

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"text": "string"
}
]
}

retrieveUserAutocomplete

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"text": "string"
}

vote-history

listVoteHistorys

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
vh_template	string vh_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}
]
}

createVoteHistory

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
vh_template	boolean or null
template_id	integer or null [ -2147483648 .. 2147483647 ]
name required	string <= 255 characters
display_title required	string <= 255 characters
date_update	string <date-time>
year required	string <= 4 characters
election_type	string or null Enum: "General" "Special" "Primary" "Presidential Primary" "Other" "Municipal - General" "Municpal - Primary"
election_date	string or null <date-time>
date_vote_cast	string or null <date-time>
method	string or null Enum: "A,B" "E,F" "M" "P,R" "Y,Z"
party	string or null Enum: "Democrat" "Republican" "Gorilla" "Other" "Non-Partisan"
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

retrieveVoteHistory

path Parameters

id

required

string

query Parameters

vh_template	string vh_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

updateVoteHistory

path Parameters

id

required

string

query Parameters

vh_template	string vh_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
vh_template	boolean or null
template_id	integer or null [ -2147483648 .. 2147483647 ]
name required	string <= 255 characters
display_title required	string <= 255 characters
date_update	string <date-time>
year required	string <= 4 characters
election_type	string or null Enum: "General" "Special" "Primary" "Presidential Primary" "Other" "Municipal - General" "Municpal - Primary"
election_date	string or null <date-time>
date_vote_cast	string or null <date-time>
method	string or null Enum: "A,B" "E,F" "M" "P,R" "Y,Z"
party	string or null Enum: "Democrat" "Republican" "Gorilla" "Other" "Non-Partisan"
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

partialUpdateVoteHistory

path Parameters

id

required

string

query Parameters

vh_template	string vh_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
vh_template	boolean or null
template_id	integer or null [ -2147483648 .. 2147483647 ]
name required	string <= 255 characters
display_title required	string <= 255 characters
date_update	string <date-time>
year required	string <= 4 characters
election_type	string or null Enum: "General" "Special" "Primary" "Presidential Primary" "Other" "Municipal - General" "Municpal - Primary"
election_date	string or null <date-time>
date_vote_cast	string or null <date-time>
method	string or null Enum: "A,B" "E,F" "M" "P,R" "Y,Z"
party	string or null Enum: "Democrat" "Republican" "Gorilla" "Other" "Non-Partisan"
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

destroyVoteHistory

path Parameters

id

required

string

query Parameters

vh_template	string vh_template
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertVoteHistory

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
vh_template	boolean or null
template_id	integer or null [ -2147483648 .. 2147483647 ]
name required	string <= 255 characters
display_title required	string <= 255 characters
date_update	string <date-time>
year required	string <= 4 characters
election_type	string or null Enum: "General" "Special" "Primary" "Presidential Primary" "Other" "Municipal - General" "Municpal - Primary"
election_date	string or null <date-time>
date_vote_cast	string or null <date-time>
method	string or null Enum: "A,B" "E,F" "M" "P,R" "Y,Z"
party	string or null Enum: "Democrat" "Republican" "Gorilla" "Other" "Non-Partisan"
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"vh_template": true,
"template_id": -2147483648,
"name": "string",
"display_title": "string",
"date_update": "2019-08-24T14:15:22Z",
"year": "stri",
"election_type": "General",
"election_date": "2019-08-24T14:15:22Z",
"date_vote_cast": "2019-08-24T14:15:22Z",
"method": "A,B",
"party": "Democrat",
"person": 0
}

vote-status

listVoteStatus

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}
]
}

createVoteStatus

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
registration_date	string or null <date-time>
earliest_state_registration_date	string or null <date-time>
earliest_registered_state required	string <= 2 characters
earliest_national_registration_date	string or null <date-time>
voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
voter_status_date	string or null <date-time>
voter_status_reason	string or null <= 100 characters
voter_status_source	string or null <= 100 characters
lka_is_active	boolean or null
is_restricted	boolean or null
is_deceased	boolean or null
is_permanent_absentee_voter	boolean or null
previous_voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
ncoa_state_moved_from	string or null <= 2 characters
ncoa_move_date	string or null <date-time>
ncoa_applied_to_mail	boolean or null
is_ncoa	string or null <= 100 characters
ncoa_application_scope	string or null <= 100 characters
ncoa_address_type	string or null <= 100 characters
change_of_address_date	string or null <date-time>
mailing_address_is_out_of_state	boolean or null
mailing_address_is_foreign	boolean or null
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

retrieveVoteStatus

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

updateVoteStatus

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
registration_date	string or null <date-time>
earliest_state_registration_date	string or null <date-time>
earliest_registered_state required	string <= 2 characters
earliest_national_registration_date	string or null <date-time>
voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
voter_status_date	string or null <date-time>
voter_status_reason	string or null <= 100 characters
voter_status_source	string or null <= 100 characters
lka_is_active	boolean or null
is_restricted	boolean or null
is_deceased	boolean or null
is_permanent_absentee_voter	boolean or null
previous_voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
ncoa_state_moved_from	string or null <= 2 characters
ncoa_move_date	string or null <date-time>
ncoa_applied_to_mail	boolean or null
is_ncoa	string or null <= 100 characters
ncoa_application_scope	string or null <= 100 characters
ncoa_address_type	string or null <= 100 characters
change_of_address_date	string or null <date-time>
mailing_address_is_out_of_state	boolean or null
mailing_address_is_foreign	boolean or null
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

partialUpdateVoteStatus

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
registration_date	string or null <date-time>
earliest_state_registration_date	string or null <date-time>
earliest_registered_state required	string <= 2 characters
earliest_national_registration_date	string or null <date-time>
voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
voter_status_date	string or null <date-time>
voter_status_reason	string or null <= 100 characters
voter_status_source	string or null <= 100 characters
lka_is_active	boolean or null
is_restricted	boolean or null
is_deceased	boolean or null
is_permanent_absentee_voter	boolean or null
previous_voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
ncoa_state_moved_from	string or null <= 2 characters
ncoa_move_date	string or null <date-time>
ncoa_applied_to_mail	boolean or null
is_ncoa	string or null <= 100 characters
ncoa_application_scope	string or null <= 100 characters
ncoa_address_type	string or null <= 100 characters
change_of_address_date	string or null <date-time>
mailing_address_is_out_of_state	boolean or null
mailing_address_is_foreign	boolean or null
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

destroyVoteStatus

path Parameters

id

required

string

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.

Responses

bulkUpsertVoteStatus

Given a list of objects, tries the match the object with ['pk']. If any of the given fields matched ( for [pk, [first_name, last_name]] it needs to match on either pk or both first_name and last_name)

Request Body schema:
application/json

originating_id	string or null <= 100 characters
reg_state required	string <= 2 characters
registration_date	string or null <date-time>
earliest_state_registration_date	string or null <date-time>
earliest_registered_state required	string <= 2 characters
earliest_national_registration_date	string or null <date-time>
voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
voter_status_date	string or null <date-time>
voter_status_reason	string or null <= 100 characters
voter_status_source	string or null <= 100 characters
lka_is_active	boolean or null
is_restricted	boolean or null
is_deceased	boolean or null
is_permanent_absentee_voter	boolean or null
previous_voter_status	string or null Enum: "Active" "Inactive" "Dropped" "Multiple Appearances" "Unmatched Member" "Unregistered"
ncoa_state_moved_from	string or null <= 2 characters
ncoa_move_date	string or null <date-time>
ncoa_applied_to_mail	boolean or null
is_ncoa	string or null <= 100 characters
ncoa_application_scope	string or null <= 100 characters
ncoa_address_type	string or null <= 100 characters
change_of_address_date	string or null <date-time>
mailing_address_is_out_of_state	boolean or null
mailing_address_is_foreign	boolean or null
person	integer

Responses

Request samples

Payload

Content type

application/json

{"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"originating_id": "string",
"reg_state": "st",
"registration_date": "2019-08-24T14:15:22Z",
"earliest_state_registration_date": "2019-08-24T14:15:22Z",
"earliest_registered_state": "st",
"earliest_national_registration_date": "2019-08-24T14:15:22Z",
"voter_status": "Active",
"voter_status_date": "2019-08-24T14:15:22Z",
"voter_status_reason": "string",
"voter_status_source": "string",
"lka_is_active": true,
"is_restricted": true,
"is_deceased": true,
"is_permanent_absentee_voter": true,
"previous_voter_status": "Active",
"ncoa_state_moved_from": "st",
"ncoa_move_date": "2019-08-24T14:15:22Z",
"ncoa_applied_to_mail": true,
"is_ncoa": "string",
"ncoa_application_scope": "string",
"ncoa_address_type": "string",
"change_of_address_date": "2019-08-24T14:15:22Z",
"mailing_address_is_out_of_state": true,
"mailing_address_is_foreign": true,
"person": 0
}

dynamic-counts

listDynamicCounts

Responses

Response samples

200

Content type

application/json

[null
]

conversationCodeDynamicCount

conversation_code calls a specific function retreiving/calculating only the required info needed for the view to work based on the passed tab parameter. This prevents having a bunch of non needed fields. Each of those functions returns a specific serializer. In case more tabs get added in the future: 1) Add an extra elif statement filtering for the new tab type, 2) Create a new function like get_conversation_overview_data or get_conversation_attempts_data to calculate/retrieve the info you need 3) Create a new serializer like DynamicCountSerializerOverview or DynamicCountSerializerOverview that you'll use in your newly created function retrun statement,

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

null

locationsDynamicCount

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

null

scriptDynamicCount

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

null

conversationCodeSettingsDynamicCount

path Parameters

id

required

string

Request Body schema:
application/json

any

Responses

Request samples

Payload

Content type

application/json

null

Response samples

201

Content type

application/json

null

response-stats

retrieveResponseStats

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

null

internal

retrieveContactHistory

path Parameters

person_id

required

string

Responses

Response samples

200

Content type

application/json

null

OpenField (1.0.0)

address-details

listAddressDetails

query Parameters

Responses

Response samples

createAddressDetail

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

addressTypesAddressDetail

Responses

Response samples

retrieveAddressDetail

path Parameters

query Parameters

Responses

Response samples

updateAddressDetail

path Parameters

query Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

partialUpdateAddressDetail

path Parameters

query Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

destroyAddressDetail

path Parameters

query Parameters

Responses

bulkUpsertAddressDetail

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

contact-batches

listContactBatchs

query Parameters

Responses

Response samples

createContactBatch

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

retrieveContactBatch

path Parameters

query Parameters

Responses

Response samples

updateContactBatch

path Parameters

query Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

partialUpdateContactBatch

path Parameters

query Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

destroyContactBatch

path Parameters

query Parameters

Responses

bulkUpsertContactBatch

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json