latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Contacts
Get contacts
List directory contacts visible to the current user. All query parameters are optional filters; blank values are ignored.
Validation & Requirements
Required Parameters
- None
Required JSON Body Fields
- None
Validations
- Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
- Invalid date values in *date* fields return 422 Unprocessable Entity.
- Missing required request body returns 422 Unprocessable Entity with Missing request body..
- Additional business-rule validation may return 422 with details in the errors array.
get/api/contacts
Query parameters
firstNamestring nullable
Filter by first name.
lastNamestring nullable
Filter by last name.
companystring nullable
Filter by company.
emailstring nullable
Filter by email address.
streetNumberstring nullable
Filter by street number.
streetNamestring nullable
Filter by street name.
zipstring nullable
Filter by ZIP code.
citystring nullable
Filter by city.
statestring nullable
Filter by state.
phonestring nullable
Filter by primary phone.
alternatePhonestring nullable
Filter by alternate phone.
faxstring nullable
Filter by fax number.