List notes
Changed onPlan: Pro. Lists the notes of the account, oldest first. To get the notes of one record, send one parent reference parameter. Its name is the model name with _id, for example company_id, contact_id, sales_lead_id, work_order_id (a sales order), invoice_id, quote_id or job_id.
stats.totalCount is the number of notes that match the request, on all pages. The list does not include replies or deleted notes.
If the account does not have the index_api_enabled feature flag, the request must include content or a parent reference parameter. The list then has only the 5 oldest notes. page has no effect, but stats.nextPage can show a next page. stats.totalCount still counts all the notes that match.
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
A parent reference parameter. The description of the operation gives the other names.
Only notes whose text contains this value. The match ignores case. In the value, % matches any text and _ matches any one character.
Capped to 5 when the account lacks the index_api_enabled flag.
Response
OK
Changes
- info
added the media type
application/jsonfor the response with the status
- info
- info
added the new optional
queryrequest parametercompany_id - info
added the new optional
queryrequest parametercontent - info
added the non-success response with the status
- info