Skip to content
Docs

Known contacts

GET
/api/workspaces/{ws}/known-contacts

People outside the team the workspace is already in touch with outside Roster: email addresses, domains (everyone there, subdomains included) and phone numbers. A hire's first email, text or help-desk reply to one of them doesn't wait for approval. source is added (by someone here) or approval (added when someone approved a first message to them). Newest first.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

Response Body

The workspace's known contacts.

application/json
Example Request
curl -X GET 'https://app.useroster.work/api/workspaces/string/known-contacts'
Example Response
{  "contacts": [    {      "id": "3f1c…",      "value": "client.example",      "kind": "domain",      "source": "added",      "createdAt": "2026-11-06T09:00:00.000Z"    },    {      "id": "9a2e…",      "value": "+971501234567",      "kind": "phone",      "source": "approval",      "createdAt": "2026-11-05T15:12:00.000Z"    }  ]}