Contacts
List contacts
Plan: Pro. At least one filter parameter is required.
get/contacts
Request
- Base URLhttps://api.shopvox.com/v1
- AuthAPI key in query parameter account_id and API key in query parameter authToken
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
company_idstring uuid
Company id.
activeboolean
Active flag.
namestring
Contact name.
searchstring
Search in name or email.
with_emailstring
If present, only contacts that have an email.
cportalboolean
Customer-portal-enabled contacts.
pageinteger
per_pageinteger
Capped to 5 when the account lacks the index_api_enabled flag.
Response
OK
Changes
No recorded changes to this operation across all 5 revisions of this API.