Get Citizen Users

Returns the users whose profiles can be viewed or edited by the logged-in user. If the logged-in user is an Authorized Agent, the returned users are Authorized Agent Clerks. A Citizen user is not authorized to see other users' profiles, so if the logged-in user is a Citizen user, no users are returned. If the logged-in user is an Automation user, Citizen Access users are returned.

Resource Information

Scopeusers

Deprecated scope name:   get_citizenaccess_citizens

App TypeAll
Authorization TypeNo authorization required
URI /v4/citizenaccess/citizens?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
expandstringNocontactsThe related objects to be returned with the response. The related object(s) will be returned if data exists; if data does not exist, the requested object(s) will not be included in the response. 7.3.3.5
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
loginNamestringNo The citizen's login name.7.3.3.4
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.3.4
result.activestring 7.3.3.4
result.contacts[]result.contacts{} 7.3.3.4
result.contacts.additionalAddresses[]result.contacts.additionalAddresses{}Additional address information.7.3.3.5
result.contacts.additionalAddresses.addressLine1stringThe first line of the address. 7.3.3.4
result.contacts.additionalAddresses.addressLine2stringThe second line of the address.7.3.3.4
result.contacts.additionalAddresses.addressLine3stringThe third line of the address.7.3.3.4
result.contacts.additionalAddresses.citystringThe name of the city.7.3.3.4
result.contacts.additionalAddresses.countryresult.contacts.additionalAddresses.country{}The name of the country.7.3.3.4
result.contacts.additionalAddresses.country.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.country.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.directionresult.contacts.additionalAddresses.direction{}The street direction of the primary address associated with the application.7.3.3.4
result.contacts.additionalAddresses.direction.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.direction.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.effectiveDatedateTimeThe date when you want the condition to become effective.7.3.3.4
result.contacts.additionalAddresses.expirationDatedateTimeThe date when the condition expires.7.3.3.4
result.contacts.additionalAddresses.faxstringThe fax number for the contact.7.3.3.4
result.contacts.additionalAddresses.faxCountryCodestringFax Number Country Code7.3.3.4
result.contacts.additionalAddresses.houseAlphaEndstringThe ending street number that makes up the address.7.3.3.4
result.contacts.additionalAddresses.houseAlphaStartstringThe beginning street number that makes up the address.7.3.3.4
result.contacts.additionalAddresses.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.contacts.additionalAddresses.isPrimarystringIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.3.4
result.contacts.additionalAddresses.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.3.4
result.contacts.additionalAddresses.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.3.4
result.contacts.additionalAddresses.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.3.4
result.contacts.additionalAddresses.phonestringThe telephone number of the contact.7.3.3.4
result.contacts.additionalAddresses.phoneCountryCodestringThe country code for the associated phone number.7.3.3.4
result.contacts.additionalAddresses.postalCodestringThe postal ZIP code for the address.7.3.3.4
result.contacts.additionalAddresses.recipientstringThe entity on the receiving end of an operation, for example a notification of an event.7.3.3.4
result.contacts.additionalAddresses.stateresult.contacts.additionalAddresses.state{}The state corresponding to the address on record.7.3.3.4
result.contacts.additionalAddresses.state.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.state.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.statusresult.contacts.additionalAddresses.status{}The contact address status.7.3.3.4
result.contacts.additionalAddresses.status.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.status.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.streetAddressstringThe street address. 7.3.3.4
result.contacts.additionalAddresses.streetEndlongThe end of a range of street numbers.7.3.3.4
result.contacts.additionalAddresses.streetNamestringThe street name for the address.7.3.3.4
result.contacts.additionalAddresses.streetPrefixstringAny part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.3.4
result.contacts.additionalAddresses.streetStartlongThe start of a range of street numbers.7.3.3.4
result.contacts.additionalAddresses.streetSuffixresult.contacts.additionalAddresses.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.3.4
result.contacts.additionalAddresses.streetSuffix.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.streetSuffixDirectionresult.contacts.additionalAddresses.streetSuffixDirection{}The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.3.4
result.contacts.additionalAddresses.streetSuffixDirection.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.typeresult.contacts.additionalAddresses.type{}The address type.7.3.3.4
result.contacts.additionalAddresses.type.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.type.valuestringThe value for the specified parameter.7.3.2
result.contacts.additionalAddresses.unitEndstringThe end parameter of a range of unit numbers.7.3.3.4
result.contacts.additionalAddresses.unitStartstringThe starting parameter of a range of unit numbers.7.3.3.4
result.contacts.additionalAddresses.unitTyperesult.contacts.additionalAddresses.unitType{}The unit type designation of the address.7.3.3.4
result.contacts.additionalAddresses.unitType.textstringThe localized display text.7.3.2
result.contacts.additionalAddresses.unitType.valuestringThe value for the specified parameter.7.3.2
result.contacts.addressresult.contacts.address{}The citizen user's address.7.3.3.5
result.contacts.address.addressLine1stringThe first line of the address. 7.3.2
result.contacts.address.addressLine2stringThe second line of the address.7.3.2
result.contacts.address.addressLine3stringThe third line of the address.7.3.2
result.contacts.address.citystringThe name of the city.7.3.2
result.contacts.address.countryresult.contacts.address.country{}The name of the country.7.3.2
result.contacts.address.country.textstringThe localized display text.7.3.2
result.contacts.address.country.valuestringThe value for the specified parameter.7.3.2
result.contacts.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.contacts.address.stateresult.contacts.address.state{}The state corresponding to the address on record.7.3.2
result.contacts.address.state.textstringThe localized display text.7.3.2
result.contacts.address.state.valuestringThe value for the specified parameter.7.3.2
result.contacts.birthCityresult.contacts.birthCity{}The city of birth for an individual.7.3.3.5
result.contacts.birthCity.textstringThe localized display text.7.3.2
result.contacts.birthCity.valuestringThe value for the specified parameter.7.3.2
result.contacts.birthDatedateTimeThe birth date of an individual.7.3.3.5
result.contacts.birthRegionresult.contacts.birthRegion{}The country of birth or region of birth for an individual.7.3.3.5
result.contacts.birthRegion.textstringThe localized display text.7.3.2
result.contacts.birthRegion.valuestringThe value for the specified parameter.7.3.2
result.contacts.birthStateresult.contacts.birthState{}The state of birth for an individual.7.3.3.5
result.contacts.birthState.textstringThe localized display text.7.3.2
result.contacts.birthState.valuestringThe value for the specified parameter.7.3.2
result.contacts.businessNamestringA secondary business name for the applicable individual.7.3.3.5
result.contacts.commentstringComments or notes about the current context.7.3.3.5
result.contacts.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.3.5
result.contacts.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.3.5
result.contacts.driverLicenseStateresult.contacts.driverLicenseState{}The state that issued the driver's license.7.3.3.5
result.contacts.driverLicenseState.textstringThe localized display text.7.3.2
result.contacts.driverLicenseState.valuestringThe value for the specified parameter.7.3.2
result.contacts.emailstringThe contact's email address.7.3.3.5
result.contacts.faxstringThe fax number for the contact.7.3.3.5
result.contacts.faxCountryCodestringFax number country code7.3.3.5
result.contacts.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.3.5
result.contacts.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.genderresult.contacts.gender{}The gender (male or female) of the individual.7.3.3.5
result.contacts.gender.textstringThe localized display text.7.3.2
result.contacts.gender.valuestringThe value for the specified parameter.7.3.2
result.contacts.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
result.contacts.individualOrOrganizationstringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.5
result.contacts.lastNamestringThe last name (surname). 7.3.3.5
result.contacts.middleNamestringThe middle name. 7.3.3.5
result.contacts.organizationNamestringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.5
result.contacts.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.phone1stringThe primary telephone number of the contact. 7.3.3.5
result.contacts.phone1CountryCodestringPhone Number 1 Country Code7.3.3.5
result.contacts.phone2stringThe secondary telephone number of the contact.7.3.3.5
result.contacts.phone2CountryCodestringPhone Number 2 Country Code7.3.3.5
result.contacts.phone3stringThe tertiary telephone number for the contact.7.3.3.5
result.contacts.phone3CountryCodestringPhone Number 3 Country Code7.3.3.5
result.contacts.postOfficeBoxstringThe post office box number.7.3.3.5
result.contacts.preferredChannelresult.contacts.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.3.5
result.contacts.preferredChannel.textstringThe localized display text.7.3.2
result.contacts.preferredChannel.valuestringThe value for the specified parameter.7.3.2
result.contacts.raceresult.contacts.race{}The contact's race/ethnicity.7.3.3.5
result.contacts.race.textstringThe localized display text.7.3.2
result.contacts.race.valuestringThe value for the specified parameter.7.3.2
result.contacts.relationresult.contacts.relation{}The contact's relationship to the application or service request.7.3.3.5
result.contacts.relation.textstringThe localized display text.7.3.2
result.contacts.relation.valuestringThe value for the specified parameter.7.3.2
result.contacts.salutationresult.contacts.salutation{}The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.7.3.3.5
result.contacts.salutation.textstringThe localized display text.7.3.2
result.contacts.salutation.valuestringThe value for the specified parameter.7.3.2
result.contacts.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.5
result.contacts.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.statusresult.contacts.status{}The contact status.7.3.3.5
result.contacts.status.textstringThe localized display text.7.3.2
result.contacts.status.valuestringThe value for the specified parameter.7.3.2
result.contacts.suffixstringThe contact name suffix.7.3.3.5
result.contacts.titlestringThe individual's business title. 7.3.3.5
result.contacts.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.3.5
result.contacts.typeresult.contacts.type{}The type of people to contact. 7.3.3.5
result.contacts.type.textstringThe localized display text.7.3.2
result.contacts.type.valuestringThe value for the specified parameter.7.3.2
result.emailstringThe citizen user's email address.7.3.3.4
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.loginNamestringThe citizen user's login name.7.3.3.4
result.mobilePhonestringThe citizen user's 10-digit cell phone number.7.3.3.4
result.receiveSMSstringIndicates whether or not the user prefers to receive SMS messages.7.3.3.4
result.registerDatedateTimeThe citizen user's registration date.7.3.3.4
result.rolestringThe citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.7.3.3.4
statusintegerThe record status.7.3.3