Owlbound
Browse the docs

Reference · 2 operations

Icps

Ideal customer profiles (audiences) and how contacts are scored against them.

Last updated from API version 2026-10-06 at (live spec, refreshed hourly). openapi.json

icps.list

List the workspace's ICPs (audiences).

get/api/v1/icps
Scope
read
Credits
Free
Idempotency-Key
Not used

Cursor-paginated (meta.page), with stored counts. A member's session lists their own and the workspace-wide ones (as the app does); a page may then be shorter than limit.

Parameters

  • limitqueryinteger

    Page size.

    default 50min 1max 200
  • cursorquerystring

    Opaque cursor from meta.page.nextCursor. Reusing it with other filters is 400 CURSOR_MISMATCH.

Responses

200
A page of ICPs.
Show schema

IcpListResponse

Errors

400 The request is invalid (VALIDATION_ERROR, CURSOR_MISMATCH, UNSUPPORTED_FILTER) · 401 Missing, invalid, expired or revoked key · 403 Missing scope, suspended workspace or unavailable identity · 404 Unknown resource or route. A resource in another workspace is also 404 · 429 Rate limit reached · 500 Unexpected error · 503 The backend is unreachable; retry after `Retry-After`. Every error is {error: {type, code, message, requestId, docUrl}}; see error codes.

curl "https://app.owlbound.ai/api/v1/icps" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

icps.get

Get an ICP with criteria, scoring and counts.

get/api/v1/icps/{id}
Scope
read
Credits
Free
Idempotency-Key
Not used

Targeting lists, scoring prompt and thresholds, contacts by connection status. An ICP of another workspace, or one a member's session does not see in the app, is 404 NOT_FOUND.

Parameters

  • idpathstringrequired

    Opaque resource id.

Responses

200
The ICP.
Show schema

IcpResponse

  • dataIcprequired
    0
  • metaResponseMetarequired

    Metadata on every success response.

    0

Errors

400 The request is invalid (VALIDATION_ERROR, CURSOR_MISMATCH, UNSUPPORTED_FILTER) · 401 Missing, invalid, expired or revoked key · 403 Missing scope, suspended workspace or unavailable identity · 404 Unknown resource or route. A resource in another workspace is also 404 · 429 Rate limit reached · 500 Unexpected error · 503 The backend is unreachable; retry after `Retry-After`. Every error is {error: {type, code, message, requestId, docUrl}}; see error codes.

curl "https://app.owlbound.ai/api/v1/icps/$ID" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

Models on this page

Shared objects the operations above link to. Clients must ignore fields they do not know.

IcpSummaryobject

An ICP as listed.

  • idstringrequired
    0
  • namestringrequired
    0
  • descriptionstring | nullrequired
    0
  • isActivebooleanrequired
    0
  • searchTargetstringrequired

    leads = people, accounts = companies.

    leadsaccounts
  • criteriaLockedbooleanrequired
    0
  • scoringConfiguredbooleanrequired

    Whether contacts can be scored against it (criteria or a scoring prompt).

    0
  • statsIcpStatsrequired
    0
  • createdAtnumberrequired
    0
  • updatedAtnumberrequired
    0
IcpStatsobject
  • contactsinteger | nullrequired

    Stored contact count (null until first counted).

    0
  • profilesScannedintegerrequired
    0
  • profilesMatchedintegerrequired
    0
  • avgScorenumber | nullrequired
    0
  • lastScanAtnumber | nullrequired
    0
PagedResponseMetaobject

Metadata on a paginated success response.

  • requestIdstringrequired
    0
  • creditsCreditsMetarequired
    0
  • pagePageMetarequired

    Cursor pagination. hasMore is the only end signal; pages may be short.

    0
CreditsMetaobject
  • usednumberrequired

    Credits charged by this request. Reads are free.

    0
  • balancenumber
    0
  • estimatednumber

    Dry run only (action operations).

    0
  • availablenumber

    Dry run only (action operations).

    0
  • reservationIdstring | null

    Async operations only; the job settles this reservation.

    0
PageMetaobject

Cursor pagination. hasMore is the only end signal; pages may be short.

  • nextCursorstring | nullrequired
    0
  • hasMorebooleanrequired
    0
  • limitintegerrequired
    min 1max 200
Icpobject

An ICP as listed.

  • criteriaIcpCriteriarequired

    Targeting criteria lists (empty when unused).

    0
  • scoringIcpScoringrequired
    0
  • audienceobjectrequired

    Live contact counts of the ICP.

    0
    + Show child fields
    • totalContactsintegerrequired
      0
    • connectionStatusobjectrequired
      0
      + Show child fields
      • connectedintegerrequired
        0
      • pendingintegerrequired
        0
      • notConnectedintegerrequired
        0
      • unknownintegerrequired
        0
    • connectionRatenumberrequired
      0
  • idstringrequired
    0
  • namestringrequired
    0
  • descriptionstring | nullrequired
    0
  • isActivebooleanrequired
    0
  • searchTargetstringrequired

    leads = people, accounts = companies.

    leadsaccounts
  • criteriaLockedbooleanrequired
    0
  • scoringConfiguredbooleanrequired

    Whether contacts can be scored against it (criteria or a scoring prompt).

    0
  • statsIcpStatsrequired
    0
  • createdAtnumberrequired
    0
  • updatedAtnumberrequired
    0
IcpCriteriaobject

Targeting criteria lists (empty when unused).

  • titlesarray of string
    max items 100
  • titlesToExcludearray of string
    max items 100
  • seniorityLevelsarray of string
    max items 100
  • industriesarray of string
    max items 100
  • companySizesarray of string
    max items 100
  • companyLocationsarray of string
    max items 100
  • keywordsarray of string
    max items 100
  • keywordsToExcludearray of string
    max items 100
  • functionsarray of string
    max items 100
  • accountIndustriesarray of string
    max items 100
  • companyHqRegionsarray of string
    max items 100
IcpScoringobject
  • enabledbooleanrequired
    0
  • promptstring | nullrequired

    The scoring prompt (the ideal customer in plain words).

    0
  • hotThresholdintegerrequired
    0
  • warmThresholdintegerrequired
    0
  • autoScoreOnEnrichbooleanrequired
    0
ResponseMetaobject

Metadata on every success response.

  • requestIdstringrequired
    0
  • creditsCreditsMetarequired
    0
  • pagePageMeta

    Cursor pagination. hasMore is the only end signal; pages may be short.

    0
  • dryRunboolean

    True only on a dry-run response (action operations).

    0

← All operations