Creators

Get creator details by ID

Retrieves detailed information about a specific creator including comprehensive user data, invitation status, associated tracked social media accounts, and profile information. Returns null if the creator is not found or doesn't belong to your organization. This endpoint provides all necessary data for viewing creator profiles and managing creator-account associations.

get/creators/{id}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/creators/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Organization creator ID with orgcre_ prefix

Response

OK

idstring required
creatorUserIdstring required
notesstring nullable required
sourceApplicationIdstring nullable required
sourceJobIdstring nullable required
createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring date-time nullable required
actorType'user' | 'system' | 'api_token' required
userIdstring required
orgIdstring required
status'not invited' | 'invitation sent' | 'invitation rejected' | 'joined' required
creatorStatus'active' | 'archived' required
isMarketplaceCreatorboolean
activeCampaignEndsAtstring nullable
campaignProrationAppliedboolean nullable
hasPreviousCampaignAssignmentsboolean

Example response

{
  "id": "orgcre_1A2B3C4D5E6F",
  "orgId": "org_abc123DEF456",
  "creatorUserId": "user_xyz789ABC012",
  "notes": "Fashion content creator specializing in sustainable brands",
  "userId": "user_admin123ABC",
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z",
  "user": {
    "id": "user_xyz789ABC012",
    "name": "Sarah Johnson",
    "firstName": "Sarah",
    "lastName": "Johnson",
    "email": "sarah.johnson@example.com",
    "emailVerified": true,
    "image": null,
    "createdAt": "2025-01-15T09:30:00.000Z",
    "updatedAt": "2025-01-15T09:30:00.000Z",
    "creatorContactProfileId": "creprof_abc123XYZ",
    "ssoUserId": null
  },
  "createdByUser": {
    "id": "user_admin123ABC",
    "name": "Admin User",
    "firstName": "Admin",
    "lastName": "User",
    "email": "admin@company.com",
    "emailVerified": true,
    "image": null,
    "createdAt": "2025-01-01T08:00:00.000Z",
    "updatedAt": "2025-01-01T08:00:00.000Z",
    "creatorContactProfileId": null,
    "ssoUserId": null
  },
  "creatorProfile": {
    "id": "creprof_abc123XYZ",
    "bio": "Sustainable fashion influencer | Eco-conscious living",
    "userId": "user_xyz789ABC012",
    "createdAt": "2025-01-15T09:30:00.000Z",
    "updatedAt": "2025-01-15T09:30:00.000Z"
  },
  "member": {
    "id": "orgmem_creator123ABC"
  },
  "invitation": null,
  "status": "joined",
  "accounts": [
    {
      "id": "orgacc_1A2B3C4D5E6F",
      "platform": "instagram",
      "platformAccountId": "17841405822304914",
      "username": "sarah_sustainable"
    },
    {
      "id": "orgacc_2B3C4D5E6F7G",
      "platform": "tiktok",
      "platformAccountId": "7123456789012345678",
      "username": "sarahsustainablestyle"
    }
  ],
  "campaignDisplay": {
    "id": "campaign_abc123",
    "name": "Creator Program",
    "status": "active",
    "startDate": "2025-01-01",
    "endDate": null
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.