Search Professionals

Finds the professionals that match the search criteria.

Resource Information

Scope	professionals Deprecated scope name: search_professionals
App Type	All
Authorization Type	Access token
URI	/v4/search/professionals?lang={lang}&offset={offset}&limit={limit}&fields={fields}
HTTP Method	POST
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	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
lang	String	No	�	Indicates the language applied.	7.3.2
limit	long	No	�	Indicates the number of items that are returned in each page.	7.3.2
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2
acaPermission	string	No	�	Access permissions for the selected ACA user groups.	7.3.2
addressLine1	string	No	�	The first line of the address.	7.3.2
addressLine2	string	No	�	The second line of the address.	7.3.2
addressLine3	string	No	�	The third line of the address.	7.3.2
birthDate	dateTime	No	�	The birth date of an individual.	7.3.2
businessLicense	string	No	�	The official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types.	7.3.2
businessName	string	No	�	A secondary business name for the applicable individual.	7.3.2
businessName2	string	No	�	A secondary business name for the applicable individual.	7.3.2
city	string	No	�	The name of the city.	7.3.2
comment	string	No	�	Comments or notes about the current context.	7.3.2
contractorBusinessName	string	No	�	The contractor's business name (65 char limit).	7.3.2
contractorLicenseNumber	long	No	�	The contractor's license number.(30 char limit).	7.3.2
country	country{}	No	Get All Address Countries	The name of the country.	7.3.2
country.text	string	No	�	The localized display text.	7.3.2
country.value	string	No	�	The value for the specified parameter.	7.3.2
email	string	No	�	The contact's email address.	7.3.2
fax	string	No	�	The fax number for the contact.	7.3.2
federalEmployerId	string	No	�	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
firstName	string	No	�	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
gender	gender{}	No	�	The gender (male or female) of the individual.	7.3.2
gender.text	string	No	�	The localized display text.	7.3.2
gender.value	string	No	�	The value for the specified parameter.	7.3.2
id	long	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
insuranceAmount	double	No	�	The cost.	7.3.2
insuranceCompany	string	No	�	The name of the company insuring the professional.	7.3.2
insuranceExpirationDate	dateTime	No	�	The date when the insurance policy is due to expire.	7.3.2
insurancePolicyNumber	string	No	�	The insurance policy number.	7.3.2
lastName	string	No	�	The last name (surname).	7.3.2
licenseExpirationDate	dateTime	No	�	The date when the license expires and is no longer valid.	7.3.2
licenseIssueDate	dateTime	No	�	The license date of issuance.	7.3.2
licenseNumber	string	No	�	This is the license number for the contact.	7.3.2
licenseState	string	No	�	The licensed professional's license number. The license is from the Contractors State License Board.	7.3.2
licenseType	licenseType{}	No	Get All Professional License Types	The type of license held by the professional.	7.3.2
licenseType.text	string	No	�	The localized display text.	7.3.2
licenseType.value	string	No	�	The value for the specified parameter.	7.3.2
licensingBoard	licensingBoard{}	No	Get All Professional License Boards	The name of the licensing board that issued the license.	7.3.2
licensingBoard.text	string	No	�	The localized display text.	7.3.2
licensingBoard.value	string	No	�	The value for the specified parameter.	7.3.2
middleName	string	No	�	The middle name.	7.3.2
phone1	string	No	�	The primary telephone number of the contact.	7.3.2
phone1CountryCode	string	No	�	Phone Number 1 Country Code	7.3.2
phone2	string	No	�	The secondary telephone number of the contact.	7.3.2
phone2CountryCode	string	No	�	Phone Number 2 Country Code	7.3.2
phone3	string	No	�	The tertiary telephone number for the contact.	7.3.2
phone3CountryCode	string	No	�	Phone Number 3 Country Code	7.3.2
postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
postOfficeBox	string	No	�	The post office box number.	7.3.2
salutation	salutation{}	No	Get All Contact Salutations	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.2
salutation.text	string	No	�	The localized display text.	7.3.2
salutation.value	string	No	�	The value for the specified parameter.	7.3.2
serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
state	state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
state.text	string	No	�	The localized display text.	7.3.2
state.value	string	No	�	The value for the specified parameter.	7.3.2
status	status{}	No	�	The license status.	7.3.2
status.text	string	No	�	The localized display text.	7.3.2
status.value	string	No	�	The value for the specified parameter.	7.3.2
suffix	string	No	�	The contact name suffix.	7.3.2
title	string	No	�	The individual's business title.	7.3.2
workerCompensationExemption	string	No	�	The code associated with the Worker's Compensation Insurance Company.	7.3.2
workerCompensationExpirationDate	dateTime	No	�	This is the expiration date of the Worker's Compensation Insurance Policy.	7.3.2
workerCompensationPolicyNumber	string	No	�	This is the policy number for the Worker's Compensation Insurance. Limit of 30 characters.	7.3.2
workerInsuranceCompanyCode	string	No	�	The code associated with the Worker's Compensation Insurance Company.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.addressLine1	string	The first line of the address.	7.3.2
result.addressLine2	string	The second line of the address.	7.3.2
result.addressLine3	string	The third line of the address.	7.3.2
result.birthDate	dateTime	The birth date of an individual.	7.3.2
result.businessLicense	string	The official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types.	7.3.2
result.businessName	string	A secondary business name for the applicable individual.	7.3.2
result.businessName2	string	A secondary business name for the applicable individual.	7.3.2
result.citizenPermission	string	Access permissions for the citizen user.	7.3.2
result.city	string	The name of the city.	7.3.2
result.comment	string	Comments or notes about the current context.	7.3.2
result.contractorBusinessName	string	The contractor's business name (65 char limit).	7.3.2
result.contractorLicenseNumber	long	The contractor's license number.(30 char limit).	7.3.2
result.country	result.country{}	The name of the country.	7.3.2
result.country.text	string	The localized display text.	7.3.2
result.country.value	string	The value for the specified parameter.	7.3.2
result.email	string	The contact's email address.	7.3.2
result.fax	string	The fax number for the contact.	7.3.2
result.federalEmployerId	string	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
result.firstName	string	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.gender	result.gender{}	The gender (male or female) of the individual.	7.3.2
result.gender.text	string	The localized display text.	7.3.2
result.gender.value	string	The value for the specified parameter.	7.3.2
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.insuranceAmount	double	The cost, in dollar amounts, of the professional’s insurance policy.	7.3.2
result.insuranceCompany	string	The name of the company insuring the professional.	7.3.2
result.insuranceExpirationDate	dateTime	The date when the insurance policy is due to expire.	7.3.2
result.insurancePolicyNumber	string	The insurance policy number.	7.3.2
result.lastName	string	The last name (surname).	7.3.2
result.lastRenewalDate	dateTime	The last date for a professionals renewal license.	7.3.2
result.licenseExpirationDate	dateTime	The date when the license expires and is no longer valid.	7.3.2
result.licenseIssueDate	dateTime	The license date of issuance.	7.3.2
result.licenseNumber	string	This is the license number for the contact.	7.3.2
result.licenseState	string	The licensed professional's license number. The license is from the Contractors State License Board.	7.3.2
result.licenseType	result.licenseType{}	The type of license held by the professional.	7.3.2
result.licenseType.text	string	The localized display text.	7.3.2
result.licenseType.value	string	The value for the specified parameter.	7.3.2
result.licensingBoard	result.licensingBoard{}	The name of the licensing board that issued the license.	7.3.2
result.licensingBoard.text	string	The localized display text.	7.3.2
result.licensingBoard.value	string	The value for the specified parameter.	7.3.2
result.middleName	string	The middle name.	7.3.2
result.phone1	string	The primary telephone number of the contact.	7.3.2
result.phone1CountryCode	string	Phone Number 1 Country Code	7.3.2
result.phone2	string	The secondary telephone number of the contact.	7.3.2
result.phone2CountryCode	string	Phone Number 2 Country Code	7.3.2
result.phone3	string	The tertiary telephone number for the contact.	7.3.2
result.phone3CountryCode	string	Phone Number 3 Country Code	7.3.2
result.postalCode	string	The postal ZIP code for the address.	7.3.2
result.postOfficeBox	string	The post office box number.	7.3.2
result.salutation	result.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.2
result.salutation.text	string	The localized display text.	7.3.2
result.salutation.value	string	The value for the specified parameter.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.state	result.state{}	The state corresponding to the address on record.	7.3.2
result.state.text	string	The localized display text.	7.3.2
result.state.value	string	The value for the specified parameter.	7.3.2
result.status	result.status{}	The license status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.suffix	string	The contact name suffix.	7.3.2
result.title	string	The individual's business title.	7.3.2
result.workerCompensationExemption	string	The code associated with the Worker's Compensation Insurance Company.	7.3.2
result.workerCompensationExpirationDate	dateTime	This is the expiration date of the Worker's Compensation Insurance Policy.	7.3.2
result.workerCompensationPolicyNumber	string	This is the policy number for the Worker's Compensation Insurance. Limit of 30 characters.	7.3.2
result.workerInsuranceCompanyCode	string	The code associated with the Worker's Compensation Insurance Company.	7.3.2
status	integer	The record status.	7.3.3