Favorites

List favorites

List all of the authenticated user's favorites across groups, views, and contacts. Returns `{ data: { favorites: [...], pagination: { nextCursor, count } } }`. Supports `?take=`, `?cursor=`, and `?ord

GET /v2/favorites/

Parameters

Query parameters

type

string enum

Possible values: "group", "view", "contact"

orderBy

object

take

integer

cursor

string (uuid)

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.favorites

array<object> required

data.favorites[].id

string (uuid) required

data.favorites[].user_id

string

data.favorites[].group_id

string (uuid) | null

data.favorites[].view_id

string (uuid) | null

data.favorites[].contact_id

string (uuid) | null

data.favorites[].ranking

integer | null

data.favorites[].created_at

string (date-time) required

data.favorites[].updated_at

string (date-time) required

data.favorites[].groups

object | null

data.favorites[].views

object | null

data.favorites[].contacts

object | null

data.pagination

object

data.pagination.nextCursor

string | null

data.pagination.count

integer

Example

{
  "data": {
    "favorites": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "created_at": "2026-08-21T15:31:00.973Z",
        "updated_at": "2026-08-21T15:31:00.973Z"
      }
    ]
  }
}

400

No response body.

401

No response body.

403

No response body.

404

No response body.

409

No response body.

429

No response body.

500

No response body.

Code samples

curl https://api.prod.getdex.com/v2/favorites/ \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v2/favorites/', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v2/favorites/",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    }
)

Delete a favorite

Unstar a group, view, or contact by deleting the favorite row. Returns the canonical bulk envelope: `{ data: { affected: 1, ids: [favoriteId] } }`. `Idempotency-Key` is optional.

Create a favorite

Star a group, view, or contact. Body must include **exactly one** of `group_id`, `view_id`, or `contact_id`. `ranking` is optional. **Requires `Idempotency-Key`.** Returns `{ data: { favorite: {...} }