Timeline

List a contact's notes

List one contact's notes, newest first, in the canonical notes list envelope, cursor-paginated. Also served in a workspace (`X-Dex-Workspace`), where it returns the workspace's shared notes on that co

GET /v2/timeline/notes

Parameters

Query parameters

contact_id

string (uuid) required

cursor

string (uuid)

take

integer

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.notes

array<object> required

data.notes[].id

string (uuid) required

data.notes[].user_id

string

data.notes[].workspace_id

string (uuid) | null

data.notes[].audience

string enum

Possible values: "private", "shared"

data.notes[].note

string | null

data.notes[].custom_emoji

string | null

data.notes[].meeting_type

string | null

data.notes[].meeting_type_id

string (uuid) | null

data.notes[].event_time

string (date-time)

data.notes[].created_at

string (date-time)

data.notes[].google_calendar_event_id_v3

string | null

data.notes[].oauth_credential_id

string (uuid) | null

data.notes[].calendar_account_email

string | null

data.notes[].calendar_account_provider

string enum

Possible values: "GOOGLE", "OFFICE365"

data.notes[].reminder_id

string (uuid) | null

data.notes[].channels

array<string enum> required

data.notes[].next_cursor

string

data.notes[].meeting_types

object | null required

data.notes[].timeline_items_contacts

array<object>

data.notes[].attachments

array<object>

data.pagination

object

data.pagination.nextCursor

string | null

data.pagination.count

integer

Example

{
  "data": {
    "notes": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "channels": [
          "whatsapp"
        ],
        "meeting_types": {}
      }
    ]
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl 'https://api.prod.getdex.com/v2/timeline/notes?contact_id=00000000-0000-0000-0000-000000000000' \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v2/timeline/notes?contact_id=00000000-0000-0000-0000-000000000000', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v2/timeline/notes",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    },
    params={
      "contact_id": "00000000-0000-0000-0000-000000000000"
    }
)

Add contacts to a group

Add one or more contacts to a group by providing an array of contact IDs. Contacts that are already members are silently skipped server-side. **Requires `Idempotency-Key`.** Returns `{ data: { affecte

Create a note

Create a note (a `timeline_items` row) optionally linked to contacts. Returns the created note in the canonical single-entity envelope.