INinstantly
Creator

Get a creator outreach batch

Changed on

The creator list and its last conversion; status is queued or running until it ends.

Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all

get/api/v2/creator-search/outreach-batches/{id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/creator-search/outreach-batches/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

Default Response

idstring uuid required

The creator list; also the id of its lead list

list_idstring uuid
agent_idstring uuid
status'preparing' | 'queued' | 'running' | 'ready' | 'attaching' | 'attached' | 'partial' | 'failed' required

queued and running mean a conversion is still in progress

platform'instagram' | 'tiktok' | 'youtube' | 'all' required
search_kind'structured' | 'ai_text' | 'lookalike' | 'result_image' | 'image_upload' required
querystring
lead_idsstring[] required
error_codestring nullable

Example response

{
  "platform": "instagram",
  "creators": [
    {
      "creator_ref": "eyJ2IjoxLCJwIjoiaW5zdGFncmFtIn0",
      "platform": "instagram",
      "name": "Jane Doe",
      "handle": "janedoe",
      "profile_url": "https://www.instagram.com/janedoe",
      "avatar_url": "https://example.com/avatar.jpg",
      "bio": "Travel and food",
      "location": "Austin, United States",
      "category": "Travel",
      "followers": 120000,
      "engagement_rate": 0.034,
      "average_views": 25000,
      "posting_frequency": 12,
      "growth_rate": 0.02,
      "has_email": true,
      "collaboration_brands": [
        "Nike"
      ]
    }
  ]
}

Changes