Skip to main content
GET
/
v1
/
web-links
List Web Links
curl --request GET \
  --url https://api.wellapp.ai/v1/web-links
{
  "data": [
    {
      "type": "social_link",
      "id": "uuid",
      "attributes": {}
    }
  ],
  "meta": {
    "total": 0,
    "count": 0
  },
  "links": {
    "next": null
  }
}

​
Complex Usage Example

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"

Query Parameters

​
limit
integer
default:50

Page size (max 200).

Required range: x <= 200
​
cursor
string

Opaque keyset cursor; omit for the first page.

​
orderBy
string

Field to order by.

​
direction
enum<string>
Available options:
asc,
desc
​
workspaceId
string<uuid>

Optional explicit workspace scope (Firebase-authenticated callers).

Response

A page of social_link records.