Skip to main content
GET
/
v1
/
medias
Get media
curl --request GET \
  --url https://api.wellapp.ai/v1/medias \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "media",
      "id": "media1",
      "attributes": {
        "media_type": "avatar",
        "url": "https://cdn.example.com/avatar.jpg",
        "is_primary": true,
        "uploaded_at": "2025-06-01T10:00:00Z",
        "processed_at": "2025-06-01T10:00:00Z"
      },
      "relationships": {
        "people": {
          "data": [
            {
              "type": "people",
              "id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77c"
            }
          ]
        },
        "companies": {
          "data": [
            {
              "type": "company",
              "id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a"
            }
          ]
        },
        "workspaces": {
          "data": [
            {
              "type": "workspace",
              "id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77b"
            }
          ]
        }
      },
      "included": [
        {
          "type": "people",
          "id": "people1",
          "attributes": {
            "first_name": "John",
            "last_name": "Doe",
            "job_title": "Software Engineer",
            "created_at": "2025-05-01T09:00:00Z",
            "updated_at": "2025-06-01T10:00:00Z"
          }
        },
        {
          "type": "company",
          "id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a",
          "attributes": {
            "name": "Tech Startup Inc",
            "description": "An innovative technology company focused on AI and ML solutions",
            "registration_tax_id": "12345678901",
            "registration_registered_value": "123456789",
            "created_at": "2025-08-03T10:38:40.967Z",
            "updated_at": "2025-08-04T07:51:01.785Z"
          }
        },
        {
          "type": "workspace",
          "id": "workspace_tenant",
          "attributes": {
            "name": "Marketing Team Workspace",
            "description": "Collaborative workspace for the marketing team to manage campaigns and content",
            "external_workspace_id": "fygr_123",
            "created_at": "2024-01-05T08:00:00Z",
            "updated_at": "2024-01-18T12:15:00Z"
          }
        }
      ]
    }
  ]
}

​
Complex Usage Example

​
Advanced Media Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, contact filtering, and sorting for retrieving media records: 
curl -X GET "https://api.well.com/v1/medias?include=people,companies,workspaces&workspace_id=550e8400-e29b-41d4-a716-446655440000&company_id=550e8400-e29b-41d4-a716-446655440001&email=user@example.com&uploaded_at_from=2025-01-01T00:00:00Z&uploaded_at_to=2025-12-31T23:59:59Z&processed_at_from=2025-06-01T00:00:00Z&registration_tax_id=12345678901&sort=-uploaded_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 related resources to include. Available options: people, companies, workspaces

​
uploaded_at_from
string<date-time>

Filter media uploaded from this date (ISO 8601 format)

​
uploaded_at_to
string<date-time>

Filter media uploaded until this date (ISO 8601 format)

​
processed_at_from
string<date-time>

Filter media processed from this date (ISO 8601 format)

​
processed_at_to
string<date-time>

Filter media processed until this date (ISO 8601 format)

​
workspace_id
string<uuid>

Filter by workspace ID

​
external_workspace_id
string

Filter by external workspace ID

​
people_id
string<uuid>

Filter by person ID

​
phone_number
string

Filter by phone number (E164 format)

​
email
string<email>

Filter by email address

​
company_id
string<uuid>

Filter by company ID

​
registration_tax_id
string

Filter by company registration tax ID

​
registration_registered_value
string

Filter by company registration registered value

​
sort
enum<string>

Sort by field. Use '-' prefix for descending order (e.g., '-created_at' for newest first)

Available options:
uploaded_at,
-uploaded_at,
processed_at,
-processed_at

Response

Media retrieved successfully

​
data
object
⌘I