Contacts
Contacts
Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
---|---|---|---|---|---|
Create Contacts | All | contacts | Access token | POST /v4/contacts | 7.3.2 |
Delete Contacts | Agency | contacts | Access token | DELETE /v4/contacts/{ids} | 7.3.2 |
Get All Contacts | All | contacts | Access token | GET /v4/contacts | 7.3.2 |
Get Contacts | All | contacts | Access token | GET /v4/contacts/{ids} | 7.3.2 |
Update Contact | Agency | contacts | Access token | PUT /v4/contacts/{id} | 7.3.2 |
Settings/Contacts
Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
---|---|---|---|---|---|
Get All Contact Preferred Channels | All | contacts | Access token | GET /v4/settings/contacts/preferredChannels | 7.3.2 |
Get All Contact Races | All | contacts | Access token | GET /v4/settings/contacts/races | 7.3.2 |
Get All Contact Relations | All | contacts | Access token | GET /v4/settings/contacts/relations | 7.3.2 |
Get All Contact Salutations | All | contacts | Access token | GET /v4/settings/contacts/salutations | 7.3.2 |
Get All Contact Types | All | contacts | Access token | GET /v4/settings/contacts/types | 7.3.2 |
Get All Custom Form Settings for Contact Type | All | settings | Access token | GET /v4/settings/contacts/types/{id}/customForms | 7.3.2 |
Overview:
Contacts
The contacts object captures information about people or organizations involved in a business process. Contacts include licensed professionals, such as contractors, architects, engineers, and developers for which your agency maintains saved data. Contacts also include individuals related to a specific application or parcel, such as the applicant, billing contacts, or legal representatives.
You can add new contacts to your system, or update information about existing contacts. As you manage applications and parcels on your system, you can keep track of certain individuals related to an application or a parcel. For example, you can keep track of the legal counsel for a property owner, or the accountant responsible for any fees assessed on a certain application.