Browse the docs

Reference · 3 operations

Companies

Companies in the workspace.

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

Companies

companies.list

List companies, newest first, with index-backed filters.

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

Cursor-paginated (meta.page). v0 (legacy) keys keep the v0 contract on this path (data: {companies, hasMore, nextCursor}).

Parameters

  • limitqueryinteger

    Page size.

    default 50min 1max 200
  • cursorquerystring

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

  • domainquerystring

    Exact domain, e.g. acme.com.

  • industryquerystring

    Exact industry.

  • linkedInUrlquerystring

    Exact LinkedIn company URL.

  • sortByquerystring

    Reserved. The sort is fixed (newest first); any value is 400 UNSUPPORTED_FILTER.

  • updatedSincequerystring

    Reserved; any value is 400 UNSUPPORTED_FILTER.

Responses

200
A page of companies.
Show schema

CompanyListResponse

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/companies" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

companies.get

Get one company with its contact count.

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

A company in another workspace is 404 NOT_FOUND.

Parameters

  • idpathstringrequired

    Opaque resource id.

Responses

200
The company.
Show schema

CompanyResponse

  • dataCompanyrequired

    One company with its contact count.

    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/companies/$ID" \
  -H "Authorization: Bearer $OWLBOUND_API_KEY" \
  -H "Owlbound-Version: 2026-10-06"

Contacts

companies.contacts.list

List a company's contacts, newest first.

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

Cursor-paginated. A company in another workspace is 404 NOT_FOUND.

Parameters

  • idpathstringrequired

    Opaque resource id.

  • limitqueryinteger

    Page size.

    default 50min 1max 200
  • cursorquerystring

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

  • includeArchivedqueryboolean

    Include archived contacts.

    default false

Responses

200
A page of the company's contacts.
Show schema

ContactListResponse

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/companies/$ID/contacts" \
  -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.

CompanySummaryobject

A company as listed.

  • idstringrequired
    0
  • namestringrequired
    0
  • linkedInUrlstringrequired
    0
  • domainstring | nullrequired
    0
  • websitestring | nullrequired
    0
  • industrystring | nullrequired
    0
  • logoUrlstring | nullrequired
    0
  • employeeCountnumber | nullrequired
    0
  • employeeRangestring | nullrequired
    0
  • headquartersCompanyHeadquarters | nullrequired
    0
  • enrichmentStatusstringrequired
    pendingenrichedfailed
  • prospectCountnumberrequired
    0
  • createdAtnumberrequired
    0
  • updatedAtnumberrequired
    0
CompanyHeadquartersobject
  • countrystring | nullrequired
    0
  • citystring | nullrequired
    0
  • addressstring | 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
Companyobject

One company with its contact count.

  • idstringrequired
    0
  • namestringrequired
    0
  • linkedInUrlstringrequired
    0
  • domainstring | nullrequired
    0
  • websitestring | nullrequired
    0
  • industrystring | nullrequired
    0
  • logoUrlstring | nullrequired
    0
  • employeeCountnumber | nullrequired
    0
  • employeeRangestring | nullrequired
    0
  • headquartersCompanyHeadquarters | nullrequired
    0
  • enrichmentStatusstringrequired
    pendingenrichedfailed
  • prospectCountnumberrequired
    0
  • createdAtnumberrequired
    0
  • updatedAtnumberrequired
    0
  • descriptionstring | nullrequired
    0
  • industriesarray of stringrequired
    0
  • specialtiesarray of stringrequired
    0
  • yearFoundednumber | nullrequired
    0
  • companyTypestring | nullrequired
    0
  • contactCountintegerrequired

    Contacts linked to this company, archived included.

    0
ResponseMetaobject

Metadata on every success response.

  • requestIdstringrequired
    0
  • creditsCreditsMetarequired
    0
  • Cursor pagination. hasMore is the only end signal; pages may be short.

    0
  • dryRunboolean

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

    0
ContactSummaryobject

A contact as listed. Documented fields are always present (null when empty).

  • idstringrequired
    0
  • firstNamestring | nullrequired
    0
  • lastNamestring | nullrequired
    0
  • emailstring | nullrequired
    0
  • phonestring | nullrequired
    0
  • linkedInUrlstring | nullrequired
    0
  • titlestring | nullrequired
    0
  • companystring | nullrequired

    Company name as captured on the contact.

    0
  • companyIdstring | nullrequired
    0
  • locationstring | nullrequired
    0
  • statusstringrequired

    Sales stage. enriching, enriched, qualified, excluded and failed are legacy values still present on older contacts.

    newreadyincompletecontactedrepliedconvertedlostenrichingenrichedqualifiedexcludedfailed
  • sourcestring | nullrequired
    0
  • scorenumber | nullrequired

    Best ICP score, 0 to 100.

    0
  • activityScorenumber | nullrequired
    0
  • tagsarray of stringrequired
    0
  • isArchivedbooleanrequired
    0
  • connectionStatusstring | nullrequired

    LinkedIn connection status.

    0
  • createdAtnumberrequired

    Ms since epoch.

    0
  • updatedAtnumber | nullrequired
    0

← All operations