Skip to content
Vocapable Developers

List a contact's notes

GET
/v1/contacts/{contact_id}/notes
curl --request GET \
  --url 'https://api.vocapable.com/v1/contacts/example/notes?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
contact_id
required
Contact Id
string

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CursorPage[ContactNote]
object
data
required
Data
Array<object>
ContactNote

One working note a rep left on a contact.

author_ref is whichever credential wrote it - an API key id, or a user id when a dashboard session did. It is not a person’s name, and nothing here resolves it to one.

object
id
required
Id
string
contact_id
required
Contact Id
string
call_id
Any of:
string
author_ref
required
Author Ref
string
body
required
Body
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "has_more": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}