Skip to main content
GET
/
api
/
contacts
List contacts
curl --request GET \
  --url https://api.tedro.io/api/contacts \
  --header 'x-workspace-id: <api-key>' \
  --cookie better-auth.session_token=
{
  "items": [
    {}
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.tedro.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
better-auth.session_token
string
cookie
required

Session cookie set by Better Auth on sign-in.

​
x-workspace-id
string
header
required

Workspace UUID. Required on all /api/* endpoints.

Query Parameters

​
search
string

Search by name or phone

​
groupId
string<uuid>

Filter by group ID

​
tags
string

Comma-separated tag filter (OR logic)

​
optedOut
enum<string>

Filter by opt-out status

Available options:
true,
false
​
limit
string

Page size (max 100)

Example:

"50"

​
offset
string

Offset for pagination

Example:

"0"

Response

Contact list

​
items
object[]
required
​
total
number
required