Creators

List all creators with user information

Retrieves paginated creators with comprehensive user data including names, emails, and profile information. Supports searching by creator name or email address. Returns creator metadata with associated user details for organization management, campaign assignment, and collaboration workflows.

get/creators

Request

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

Query parameters

pagenumber

Page number (1-based index)

Example:1
perPagenumber

Number of items per page (1-100)

Example:10
'name' | 'status' | 'email' | 'firstName' | 'lastName' | 'createdAt' | 'updatedAt'
OR
string
sortDir'asc' | 'desc'

Sort direction

Example:asc
searchstring
idsstring[]

Filter by creator IDs.

campaignsstring[]

Filter by the creator's latest campaign assignment.

statusesstring[]
tagsstring[] nullable

Tag IDs. Custom and project tags must all match (intersection); country tags and continent:<CODE> values combine into one geographic group satisfied by any of them. none:<category> values (custom/project/country/continent) match entities WITHOUT any tag of the category. Ignored when tagGroups is provided.

[
  "orgtag_1A2B3C4D5E6F"
]
mode'any' | 'all' required

How the group's tags combine: any = OR, all = intersection.

idsstring[] required

Tag IDs, including continent:<CODE> and none:<category> values.

[
  {
    "mode": "all",
    "ids": [
      "orgtag_1A2B3C4D5E6F"
    ]
  },
  {
    "mode": "any",
    "ids": [
      "systag_1A2B3C4D5E6F",
      "continent:EU"
    ]
  }
]
tagsMatch'rules' | 'videos'

How the tag filter targets rows: rules (default) matches entity-level tag rules only; videos matches rows with at least one video satisfying the whole filter.

Example:rules

Response

OK

pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "data": [
    {
      "tags": [
        {
          "scope": "system",
          "color": "#2563EB"
        }
      ],
      "accountTags": [
        {
          "scope": "system",
          "color": "#2563EB"
        }
      ],
      "campaignDisplay": {
        "status": "active",
        "timeZone": "UTC"
      },
      "warnings": [
        {
          "accounts": [
            {
              "platform": "facebook",
              "platformAccountId": "7123456789012345678"
            }
          ]
        }
      ]
    }
  ]
}

Changes

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