Get web-Link
/v1/web-linksReturns a cursor-paginated, workspace-scoped list of web link (social link) rows from the records pipeline. Read-only; no side effects. Web links are created and deleted as sub-resources of a person or company. ## Filtering & sorting Filter via `POST /v1/records/query` (root `web_links`) or the `filters` model; operators are gated by each field's data type. See [Filtering & sorting](../filtering-and-sorting). **Filterable fields** | Field | Type | Allowed operators | |---|---|---| | `composite_companies_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_people_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_web_link_summary` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `created_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `deleted_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `pk` | number | `eq` `neq` `gt` `gte` `lt` `lte` `is_null` `is_not_null` | | `platform` | enum | `eq` `neq` `in` `is_null` `is_not_null` | | `social_link_id` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `updated_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `url` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | **Sortable fields:** `composite_companies_list`, `composite_people_list`, `composite_web_link_summary`, `created_at`, `deleted_at`, `pk`, `platform`, `social_link_id`, `updated_at`, `url` (via `orderBy` / `sort`, `asc`|`desc`).
Requires a bearer token: Authorization: Bearer <token>.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| limit | string | No | Page size, 1 to 200.e.g. 50 |
| cursor | string | No | Opaque cursor from a prior page's links.next.e.g. eyJwayI6OTl9 |
| orderBy | string | No | Column to order by.e.g. created_at |
| direction | string | No | Sort direction.e.g. desc |
| workspaceId | string <uuid> | No | Workspace to scope to; defaults to the token's workspace.e.g. 8f6b2c10-4a1e-4d2b-9c3a-1f0e7a5b6c21 |
Request
curl -X GET https://api.wellapp.ai/v1/web-links \
-H "Authorization: Bearer $WELL_API_TOKEN"Responses
200 — A page of web link rows.
{
"data": [
{
"type": "social_link",
"id": "9b0c1d2e-3f40-4516-9728-3a4b5c6d7e8f",
"attributes": {
"url": "https://www.linkedin.com/company/foldspace-ai",
"platform": "linkedin"
}
}
],
"meta": {
"total": 12,
"count": 1
},
"links": {
"next": null
}
}401 — Unauthorized
{
"code": "UNAUTHORIZED",
"status": 401,
"title": "Unauthorized",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}403 — Forbidden
{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}Complex Usage Example
Advanced Web Links Filtering with Full Context
This example demonstrates advanced filtering with multiple parameters, relationship inclusion, and sorting for retrieving web links and social media profiles:
curl -X GET "https://api.well.com/v1/web-links?include=workspace,persons,companies&filter[workspace_id]=123e4567-e89b-12d3-a456-426614174000&filter[external_workspace_id]=ext_workspace_123&filter[created_at]=2025-01-01T00:00:00Z&filter[updated_at]=2025-01-01T00:00:00Z&sort=-created_at" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"