Touchpoints
List touchpoints
A paginated list of touchpoints (recorded interactions). Scope to a single person using the nested /people/{person_id}/touchpoints collection.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
include?string
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
sort?string
Comma-separated list of attributes to sort by. Prefix with - for
descending order (-created_at,family_name).
page?
Offset pagination parameters.
filter?
Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.
Common predicates by attribute type:
- String / text / uuid:
eq,not_eq,cont,not_cont,matches,start,end,present,blank,null,not_null,in,not_in - Datetime:
eq,not_eq,gt,gteq,lt,lteq,present,blank,null,not_null,in,not_in
Example: ?filter[action_eq]=login
fields[touchpoints]?array<>
Sparse-fieldset selection.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/touchpoints"{ "data": [ { "type": "touchpoints", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "action": "string", "details": "string", "code": "string", "data": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "relationships": { "person": { "data": { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }, "service": { "data": { "type": "services", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }, "author": { "data": { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } } }, "links": { "self": "/touchpoints/7247ad7d-9275-454b-9e3a-0570e403739e" }, "meta": {} } ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}