Skip to content
Home/
REST API Reference
/
/
Company Note

Company Note

Notes allow you to annotate and comment on companies.

typestring

String representing the object's type. Always has the value note.

Example:"note"
idstring

The id of the note.

Example:"17495962"
created_atinteger, (timestamp)

The time the note was created.

Example:1674589321
companyobject or null

Represents the company that the note was created about.

authorobject or null(Admin)

Optional. Represents the Admin that created the note.

bodystring

The body text of the note.

Example:"<p>Text for the note.</p>"
{
  "type": "note",
  "id": "17495962",
  "created_at": 1674589321,
  "company": {
    "type": "company",
    "id": "6329bd9ffe4e2e91dac76188"
  },
  "author": {
    "type": "admin",
    "id": "1295",
    "name": "Joe Example",
    "email": "jdoe@example.com",
    "job_title": "Associate",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "away_status_reason_id": 12345,
    "has_inbox_seat": true,
    "team_ids": [ … ],
    "avatar": "https://picsum.photos/200/300",
    "team_priority_level": { … },
    "role": { … }
  },
  "body": "<p>Text for the note.</p>"
}