vlayervlayer docs
API reference

Creators

List registered creators, refresh a creator's Instagram or TikTok profile data, and check whether an Instagram handle is verified.

List all creators

Lists all users with linked social accounts, including campaign stats (attempts, verified, rewarded, points).

GET
/admin/creators

Authorization

AuthorizationRequiredBearer <token>

API token. Send it as Authorization: Bearer <API_TOKEN>.

In: header

curl -X GET "//admin/creators" \
  -H "Authorization: Bearer <token>"

Creator list

{
  "data": [
    {
      "userId": 42,
      "email": "jane@example.com",
      "displayName": "string",
      "avatarUrl": "string",
      "platform": "instagram",
      "platformUsername": "creator_jane",
      "connectedAt": "2019-08-24T14:15:22Z",
      "profileData": {
        "profile_pic_url": "https://...",
        "full_name": "Jane Creator",
        "biography": "Content creator",
        "is_verified": true,
        "followers": 15400,
        "following": 312
      },
      "totalAttempts": 5,
      "totalVerified": 4,
      "totalRewarded": 3,
      "totalPoints": 300
    }
  ]
}

Refresh creator profile

Fetches the latest profile data (Instagram or TikTok) and replaces the stored profile wholesale rather than merging into it. data is the new profile object itself, not the creator.

If the profile cannot be read, the reason is propagated — see the ScrapingError schema. If it is read but comes back empty, the route returns 200 and data is {} — which also clears the stored profile, so keep the previous copy if you need it.

POST
/admin/creators/{userId}/refresh

Authorization

AuthorizationRequiredBearer <token>

API token. Send it as Authorization: Bearer <API_TOKEN>.

In: header

Path Parameters

userIdRequiredinteger
curl -X POST "//admin/creators/{userId}/refresh" \
  -H "Authorization: Bearer <token>"

Updated profile data

{
  "data": {}
}

Verify Instagram handle

Check if an Instagram handle has a verified (connected) social account in the system.

GET
/admin/creators/verify/{handle}

Authorization

AuthorizationRequiredBearer <token>

API token. Send it as Authorization: Bearer <API_TOKEN>.

In: header

Path Parameters

handleRequiredstring
curl -X GET "//admin/creators/verify/creator_jane" \
  -H "Authorization: Bearer <token>"

Verification result

{
  "data": {
    "verified": true
  }
}

Last updated on

Challenge data

Read and refresh the comments, likers and post metrics on a challenge post, and administer its attempts.

Social accounts

Connect a creator's Instagram or TikTok account through Vouch, list connected accounts, or link a handle directly as admin.