/

/

Get list details

VwD External API (1.0.0)

External API for accessing VwD creators data.

Download OpenAPI description

Overview

VwD API Support

License

Servers

VwD Production API Server

https://api.vwd.ai/api/public/v1/

Mock server

https://apidocs.vwd.ai/_mock/apis/

Creator Management

Endpoints related to creators information and searches.

Operations

Content Analysis

Endpoints for retrieving creators posts with labels.

Operations

Brand Mentions

Endpoints for creators posts and timelines related to brands.

Operations

Compliance Monitoring

Endpoints for creators compliance data.

Operations

Coming Soon

Upcoming endpoints that will be available in future releases.

Operations

List creator lists

Request

Coming Soon

List creator lists for the organization (API key). Supports pagination via page and limit query params.

Query

pageinteger

Page number for pagination.

Example: page=1

limitinteger

Number of results per page.

Example: limit=10

curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/lists/?limit=10&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved lists.

Bodyapplication/json

listsArray of objects

totalinteger

Total number of lists

Example: 10

countinteger

Number of lists in current page

Example: 2

nextstring or null

URL for next page

Example: null

Response

application/json

{
  "lists": [
    { … }
  ],
  "total": 10,
  "count": 2,
  "next": null
}

Get list details

Request

Coming Soon

Retrieve a single list with metadata and a paginated preview of its creators.

Path

idstring(uuid)required

List ID (UUID)

Example: 00000000-0000-0000-0000-000000000000

Query

pageinteger

Page number for pagination.

Example: page=1

limitinteger

Number of results per page.

Example: limit=10

include_child_scoresboolean

true (default): return both top-level parent categories and child/leaf tags (zero-filled)
false: return parent category scores only (top-level categories)

Default true

Example: include_child_scores=true

curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/lists/00000000-0000-0000-0000-000000000000/?include_child_scores=true&limit=10&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved list details.

Bodyapplication/json

idstring(uuid)

Example: "00000000-0000-0000-0000-000000000000"

namestring

Example: "List A"

influencers_countinteger

Example: 5

creatorsArray of objects(CreatorWithBrands)

totalinteger

Total number of creators in the list

Example: 5

countinteger

Number of creators in current page

Example: 2

nextstring or null

URL for next page

Example: "/api/public/v1/lists/000.../?page=2&limit=2"

Response

application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "List A",
  "influencers_count": 5,
  "creators": [
    { … }
  ],
  "total": 5,
  "count": 2,
  "next": "/api/public/v1/lists/000.../?page=2&limit=2"
}

Add creators to list

Request

Coming Soon

Add existing creators (by id) to a list. Idempotent: adding the same creator again returns it under already_present.

Path

idstring(uuid)required

List ID (UUID)

Example: 00000000-0000-0000-0000-000000000000

Bodyapplication/jsonrequired

influencer_idsArray of integersrequired

Array of creator IDs to add to the list

Example: [1,2,3]

curl -i -X POST \
  https://api.vwd.ai/api/public/v1/lists/00000000-0000-0000-0000-000000000000/creators/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "influencer_ids": [
      1,
      2,
      3
    ]
  }'

Responses

Creators added to list successfully

Bodyapplication/json

added_influencersArray of integers

IDs of creators successfully added

Example: [1,2]

already_presentArray of integers

IDs of creators already in the list

Example: [2]

not_found_influencersArray of integers

IDs of creators not found or not accessible

Example: [999]

Response

application/json

{
  "added_influencers": [
    1,
    2
  ],
  "already_present": [
    2
  ],
  "not_found_influencers": [
    999
  ]
}