Documentation

// no parameters

{
  linkedin: {
    connected: boolean
    status?: string
    connectionSyncStatus?: "RUNNING" | "IDLE" | "FAILED"
    syncedConnectionCount?: number
  }
  budget: { sendsToday: number; dailyCap: 50 }
  credits: {
    balance: number             // in credits (1 credit = 1¢)
    lowBalance: boolean
    lowBalanceThreshold: number
    pricing: Record<string, number>
  }
  batches: {
    inflight: { jobId: number; status: string; progress: object } | null
  }
}

{
  afterId?: number
  limit?: number               // 1-200, default 50
}

{
  connections: Array<{
    id: number
    name: string
    title: string | null
    company: string | null
    profileUrl: string
    urn: string
  }>
  nextAfterId: number | null
}

{ profileUrl: string /* URL */ }

{
  status: "connected" | "pending" | "none"
  profileUrl: string
  urn: string | null
}

{
  since?: string               // ISO timestamp
  afterId?: number
  limit?: number               // 1-100
}

{
  events: Array<{
    id: number
    eventType: "reply" | "accept" | "decline" | "message"
    profileUrl: string
    summary: string | null
    occurredAt: string
  }>
}

{ url: string /* workflow URL or path */ }

{
  title: string
  slug: string
  visibility: "public" | "unlisted" | "private"
  contentMd: string
}

{ profileUrl: string /* URL */ }

{
  provider_id: string                    // LinkedIn URN — feeds send_*
  public_identifier: string              // the /in/<slug> slug
  first_name: string
  last_name: string
  headline: string | null
  summary: string | null                 // "about" section
  profile_picture_url: string | null

  network_distance: "DISTANCE_1" | "DISTANCE_2" | "OUT_OF_NETWORK"
  pending_invitation: boolean            // true if YOU sent a pending request
  is_premium: boolean
  is_open_profile: boolean
  follower_count: number | null
  connections_count: number | null

  location: {
    country: string | null
    city: string | null
  }

  current_positions: Array<{
    company_name: string
    company_id?: string
    title: string
    description: string | null
    start_year: number | null
    end_year: number | null              // null = current
  }>

  past_positions: Array<{
    company_name: string
    title: string
    start_year: number | null
    end_year: number | null
  }>

  education: Array<{
    school_name: string
    degree: string | null
    field_of_study: string | null
    start_year: number | null
    end_year: number | null
  }>

  skills: string[]
  languages: Array<{ name: string; proficiency: string | null }>
}

{
  chatId: string
  limit?: number               // 1-100
  cursor?: string
}

{
  items: Array<{
    sender: string
    text: string
    timestamp: string
  }>
  cursor: string | null
}

{
  targetProfileUrl: string     // URL
  targetUrn?: string           // skips one lookup if already known
}

{
  mutuals: Array<{
    urn: string
    name: string | null
    title: string | null
    company: string | null
    profileUrl: string | null
    strength: number
  }>
  count: number
  rawUrnCount: number
  targetUrn: string
}

{
  name?: string
  domain?: string              // client-side filter on results
  perPage?: number             // 1-25
  page?: number                // 1+
}

{
  results: Array<{
    id: string                 // → people_search.organizationIds
    name: string | null
    domain: string | null
    linkedinUrl: string | null
    industry: string | null
    employees: number | null
    description: string | null
  }>
  page: number
  perPage: number
  totalAvailable: number | null
  hasMore: boolean
  nextPage: number | null
  searchCapacity: "ok" | "limited" | "depleted"
}

{
  titles?: string[]
  organizationIds?: string[]   // from organization_search
  locations?: string[]
  keywords?: string
  perPage?: number             // 1-25
  page?: number                // 1+
}

{
  results: Array<{
    name: string | null
    title: string | null
    company: string | null
    location: string | null
    linkedinUrl: string        // → get_profile
  }>
  page: number
  perPage: number
  totalAvailable: number | null
  hasMore: boolean
  nextPage: number | null
  searchCapacity: "ok" | "limited" | "depleted"
}

{
  profileUrl: string           // URL
  providerId: string           // LinkedIn URN from get_profile
  note?: string                // ≤200 chars
}

{
  ok: boolean
  sentAt?: string
  reason?: "rate_limit" | "dedup" | "no_linkedin_account" | string
}

{
  profileUrl: string           // URL
  text: string                 // ≤8000 chars
  chatId?: string              // for existing threads
  providerId?: string          // for new chats — from get_profile
}

{
  ok: boolean
  chatId?: string
  reason?: "rate_limit" | "dedup" | "no_linkedin_account" | string
}

{
  profileUrl: string           // URL
  invitationId: string         // Unipile invitation id
}

{
  ok: boolean
  cancelledAt?: string
}

{
  profileUrls: string[]        // 1-20 LinkedIn URLs
}

{
  jobId: number
  status: "queued"
  total: number
  creditsReserved: number      // total × 5
  estimatedDurationSec: number
  instructions: string         // "save jobId, poll get_batch, ..."
}

{ jobId: number }

{
  jobId: number
  status: "queued" | "running" | "succeeded" | "failed" | "canceled"
  progress: {
    processed: number
    total: number
    currentUrl: string | null
  }
  output?: {                   // populated when status === succeeded
    results: Record<string,
      | { mutuals: Array<{ urn; name; profileUrl }>; count: number }
      | { error: string }
    >
  }
  errorMessage?: string
  completedAt?: string
}

{ jobId: number }

{
  canceled: boolean
  processedAtCancel: number
  total: number
  refundedCredits: number
}

{
  amountUsd: number            // whole dollars, $5-$5,000
}

{
  checkoutUrl: string
  amountUsd: number
  creditsAwarded: number
  bonusCredits: number
  bonusPct: number
  instructions: string         // "show URL to user, they must click it"
}