Skip to main content
GET
/
v1
/
crm
/
agents
/
{agentId}
/
notes
/
{noteId}
Get a Note
curl --request GET \
  --url https://api.example.com/v1/crm/agents/{agentId}/notes/{noteId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isPrivate": true,
  "comment": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

​
agentId
string
required
​
noteId
string
required

Response

The agent note corresponding to the primary identifier.

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
type
enum<string>
required
Available options:
public,
private,
uwRisk,
user,
system,
sam,
signnow,
clear,
underwriting,
audit
​
isPrivate
boolean
required
​
comment
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
createdBy
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
updatedBy
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$