Skip to main content
GET
/
v1
/
web-links
Get web links
curl --request GET \
  --url https://api.wellapp.ai/v1/web-links \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "web_link",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "attributes": {
        "platform": "linkedin",
        "url": "https://linkedin.com/company/tech-startup-inc",
        "created_at": "2025-08-04T10:30:00.000Z",
        "updated_at": "2025-08-04T10:30:00.000Z"
      },
      "relationships": {
        "persons": {
          "data": [
            {
              "type": "people",
              "id": "person1"
            }
          ]
        },
        "companies": {
          "data": [
            {
              "type": "company",
              "id": "company1"
            }
          ]
        },
        "workspaces": {
          "data": [
            {
              "type": "workspace",
              "id": "workspace1"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "workspace",
      "id": "workspace1",
      "attributes": {
        "name": "Tech Startup Workspace",
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T00:00:00Z"
      }
    }
  ]
}

​
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"

Headers

​
Authorization
string
required

Bearer token for authentication

Query Parameters

​
include
string

Comma-separated list of relationships to include detailed data for. Available options: workspace, persons, companies

​
filter[created_at]
string<date-time>

Filter by creation date (ISO 8601 format)

​
filter[updated_at]
string<date-time>

Filter by last update date (ISO 8601 format)

​
filter[workspace_id]
string<uuid>

Filter by workspace ID

​
filter[external_workspace_id]
string

Filter by external workspace ID

​
sort
enum<string>

Sort results by field. Prefix with '-' for descending order

Available options:
created_at,
-created_at,
updated_at,
-updated_at

Response

Web links retrieved successfully

​
data
object