List notes

Contacts API · contacts.notes.list

URL · Fields · Example · Response · Try it

URL and authentication

POST https://YOUR-BACKEND/api/automation/v1/execute

Send Authorization: Bearer <connection key>, Accept: application/json and Content-Type: application/json. Create a connection.

This operation requires read access and CRM permission view_contact_followups. The gateway invokes GET /api/v1/app/lead-contact/{entity_id}/notes internally. Use the POST URL above with your automation key, including for read and delete operations.

Request parameters

Fields

Fields below belong inside data. Dot paths describe nested objects; * means each array item. nullable permits null and sometimes validates a supplied field. in: lists allowed values; min: and max: limit the value, length or item count. exists: and exists_in_company: require a valid record ID. Conditional rules such as required_if and required_with refer to other fields in the same payload. Use YYYY-MM-DD for date-only values and timestamps with timezone offsets for follow-ups.

Example request

Replace the example IDs and values with records in your installation. Supply any additional custom fields required by your company.

{
  "operation": "contacts.notes.list",
  "parameters": {
    "entity_id": 1
  },
  "data": {
    "page": 1,
    "per_page": 25
  }
}

Response

Returns matching records in data. Paginated results include meta.current_page, meta.last_page, meta.per_page, meta.total and meta.has_more_pages. Increment the request’s data.page while more pages remain. Related fields depend on record visibility and the resource.

The gateway preserves the underlying HTTP status and JSON body. Successful requests return HTTP 200. A response may also include localized message fields.

Illustrative response excerpt (additional fields may be returned):

{
  "status": "success",
  "data": [],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 0,
    "has_more_pages": false
  }
}

Errors

Validation failures may return message / errors, or an error string with an optional fields array. The tester shows the actual HTTP status and full body. Read about limits and retries.

Try it

entity_id must be a positive integer record ID.