Search Professionals

Finds the professionals that match the search criteria.

Resource Information

Scopeprofessionals

Deprecated scope name:   search_professionals

App TypeAll
Authorization TypeAccess token
URI /v4/search/professionals?lang={lang}&offset={offset}&limit={limit}&fields={fields}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
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
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
acaPermissionstringNo Access permissions for the selected ACA user groups.7.3.2
addressLine1stringNo The first line of the address. 7.3.2
addressLine2stringNo The second line of the address.7.3.2
addressLine3stringNo The third line of the address.7.3.2
birthDatedateTimeNo The birth date of an individual.7.3.2
businessLicensestringNo 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
businessNamestringNo A secondary business name for the applicable individual.7.3.2
businessName2stringNo A secondary business name for the applicable individual.7.3.2
citystringNo The name of the city.7.3.2
commentstringNo Comments or notes about the current context.7.3.2
contractorBusinessNamestringNo The contractor's business name (65 char limit).7.3.2
contractorLicenseNumberlongNo The contractor's license number.(30 char limit).7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNo The localized display text.7.3.2
country.valuestringNo The value for the specified parameter.7.3.2
emailstringNo The contact's email address.7.3.2
faxstringNo The fax number for the contact.7.3.2
federalEmployerIdstringNo The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
firstNamestringNo The contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
gendergender{}No The gender (male or female) of the individual.7.3.2
gender.textstringNo The localized display text.7.3.2
gender.valuestringNo The value for the specified parameter.7.3.2
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
insuranceAmountdoubleNo The cost.7.3.2
insuranceCompanystringNo The name of the company insuring the professional.7.3.2
insuranceExpirationDatedateTimeNo The date when the insurance policy is due to expire.7.3.2
insurancePolicyNumberstringNo The insurance policy number.7.3.2
lastNamestringNo The last name (surname). 7.3.2
licenseExpirationDatedateTimeNo The date when the license expires and is no longer valid.7.3.2
licenseIssueDatedateTimeNo The license date of issuance. 7.3.2
licenseNumberstringNo This is the license number for the contact.7.3.2
licenseStatestringNo The licensed professional's license number. The license is from the Contractors State License Board. 7.3.2
licenseTypelicenseType{}No Get All Professional License Types The type of license held by the professional.7.3.2
licenseType.textstringNo The localized display text.7.3.2
licenseType.valuestringNo The value for the specified parameter.7.3.2
licensingBoardlicensingBoard{}No Get All Professional License Boards The name of the licensing board that issued the license. 7.3.2
licensingBoard.textstringNo The localized display text.7.3.2
licensingBoard.valuestringNo The value for the specified parameter.7.3.2
middleNamestringNo The middle name. 7.3.2
phone1stringNo The primary telephone number of the contact. 7.3.2
phone1CountryCodestringNo Phone Number 1 Country Code7.3.2
phone2stringNo The secondary telephone number of the contact.7.3.2
phone2CountryCodestringNo Phone Number 2 Country Code7.3.2
phone3stringNo The tertiary telephone number for the contact.7.3.2
phone3CountryCodestringNo Phone Number 3 Country Code7.3.2
postalCodestringNo The postal ZIP code for the address.7.3.2
postOfficeBoxstringNo The post office box number.7.3.2
salutationsalutation{}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.textstringNo The localized display text.7.3.2
salutation.valuestringNo The value for the specified parameter.7.3.2
serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
statestate{}No Get All Address States The state corresponding to the address on record.7.3.2
state.textstringNo The localized display text.7.3.2
state.valuestringNo The value for the specified parameter.7.3.2
statusstatus{}No The license status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
suffixstringNo The contact name suffix.7.3.2
titlestringNo The individual's business title. 7.3.2
workerCompensationExemptionstringNo The code associated with the Worker's Compensation Insurance Company.7.3.2
workerCompensationExpirationDatedateTimeNo This is the expiration date of the Worker's Compensation Insurance Policy.7.3.2
workerCompensationPolicyNumberstringNo This is the policy number for the Worker's Compensation Insurance. Limit of 30 characters.7.3.2
workerInsuranceCompanyCodestringNo The code associated with the Worker's Compensation Insurance Company.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addressLine1stringThe first line of the address. 7.3.2
result.addressLine2stringThe second line of the address.7.3.2
result.addressLine3stringThe third line of the address.7.3.2
result.birthDatedateTimeThe birth date of an individual.7.3.2
result.businessLicensestringThe 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.businessNamestringA secondary business name for the applicable individual.7.3.2
result.businessName2stringA secondary business name for the applicable individual.7.3.2
result.citizenPermissionstringAccess permissions for the citizen user.7.3.2
result.citystringThe name of the city.7.3.2
result.commentstringComments or notes about the current context.7.3.2
result.contractorBusinessNamestringThe contractor's business name (65 char limit).7.3.2
result.contractorLicenseNumberlongThe contractor's license number.(30 char limit).7.3.2
result.countryresult.country{}The name of the country.7.3.2
result.country.textstringThe localized display text.7.3.2
result.country.valuestringThe value for the specified parameter.7.3.2
result.emailstringThe contact's email address.7.3.2
result.faxstringThe fax number for the contact.7.3.2
result.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.genderresult.gender{}The gender (male or female) of the individual.7.3.2
result.gender.textstringThe localized display text.7.3.2
result.gender.valuestringThe value for the specified parameter.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.insuranceAmountdoubleThe cost, in dollar amounts, of the professional’s insurance policy.7.3.2
result.insuranceCompanystringThe name of the company insuring the professional.7.3.2
result.insuranceExpirationDatedateTimeThe date when the insurance policy is due to expire.7.3.2
result.insurancePolicyNumberstringThe insurance policy number.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.lastRenewalDatedateTimeThe last date for a professionals renewal license.7.3.2
result.licenseExpirationDatedateTimeThe date when the license expires and is no longer valid.7.3.2
result.licenseIssueDatedateTimeThe license date of issuance. 7.3.2
result.licenseNumberstringThis is the license number for the contact.7.3.2
result.licenseStatestringThe licensed professional's license number. The license is from the Contractors State License Board. 7.3.2
result.licenseTyperesult.licenseType{}The type of license held by the professional.7.3.2
result.licenseType.textstringThe localized display text.7.3.2
result.licenseType.valuestringThe value for the specified parameter.7.3.2
result.licensingBoardresult.licensingBoard{}The name of the licensing board that issued the license. 7.3.2
result.licensingBoard.textstringThe localized display text.7.3.2
result.licensingBoard.valuestringThe value for the specified parameter.7.3.2
result.middleNamestringThe middle name. 7.3.2
result.phone1stringThe primary telephone number of the contact. 7.3.2
result.phone1CountryCodestringPhone Number 1 Country Code7.3.2
result.phone2stringThe secondary telephone number of the contact.7.3.2
result.phone2CountryCodestringPhone Number 2 Country Code7.3.2
result.phone3stringThe tertiary telephone number for the contact.7.3.2
result.phone3CountryCodestringPhone Number 3 Country Code7.3.2
result.postalCodestringThe postal ZIP code for the address.7.3.2
result.postOfficeBoxstringThe post office box number.7.3.2
result.salutationresult.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.textstringThe localized display text.7.3.2
result.salutation.valuestringThe value for the specified parameter.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.stateresult.state{}The state corresponding to the address on record.7.3.2
result.state.textstringThe localized display text.7.3.2
result.state.valuestringThe value for the specified parameter.7.3.2
result.statusresult.status{}The license status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.suffixstringThe contact name suffix.7.3.2
result.titlestringThe individual's business title. 7.3.2
result.workerCompensationExemptionstringThe code associated with the Worker's Compensation Insurance Company.7.3.2
result.workerCompensationExpirationDatedateTimeThis is the expiration date of the Worker's Compensation Insurance Policy.7.3.2
result.workerCompensationPolicyNumberstringThis is the policy number for the Worker's Compensation Insurance. Limit of 30 characters.7.3.2
result.workerInsuranceCompanyCodestringThe code associated with the Worker's Compensation Insurance Company.7.3.2
statusintegerThe record status.7.3.3