Reference · 3 operations
Companies
Companies in the workspace.
Last updated from API version 2026-10-06 at (live spec, refreshed hourly). openapi.json
Companies
List companies, newest first, with index-backed filters.
/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 is400 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
200A page of companies.Show schema
CompanyListResponse
- 0
- 0
Metadata on a paginated success response.
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"Get one company with its contact count.
/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
200The company.Show schema
CompanyResponse
- 0
One company with its contact count.
- 0
Metadata on every success response.
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
List a company's contacts, newest first.
/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 is400 CURSOR_MISMATCH. - includeArchivedqueryboolean
Include archived contacts.
default false
Responses
200A page of the company's contacts.Show schema
ContactListResponse
- 0
- 0
Metadata on a paginated success response.
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.
- idstringrequired0
- namestringrequired0
- linkedInUrlstringrequired0
- domainstring | nullrequired0
- websitestring | nullrequired0
- industrystring | nullrequired0
- logoUrlstring | nullrequired0
- employeeCountnumber | nullrequired0
- employeeRangestring | nullrequired0
- 0
- enrichmentStatusstringrequiredpendingenrichedfailed
- prospectCountnumberrequired0
- createdAtnumberrequired0
- updatedAtnumberrequired0
CompanyHeadquartersobject
- countrystring | nullrequired0
- citystring | nullrequired0
- addressstring | nullrequired0
PagedResponseMetaobject
Metadata on a paginated success response.
- requestIdstringrequired0
- 0
- 0
Cursor pagination.
hasMoreis the only end signal; pages may be short.
CreditsMetaobject
- usednumberrequired0
Credits charged by this request. Reads are free.
- balancenumber0
- estimatednumber0
Dry run only (action operations).
- availablenumber0
Dry run only (action operations).
- reservationIdstring | null0
Async operations only; the job settles this reservation.
PageMetaobject
Cursor pagination. hasMore is the only end signal; pages may be short.
- nextCursorstring | nullrequired0
- hasMorebooleanrequired0
- limitintegerrequiredmin 1max 200
Companyobject
One company with its contact count.
- idstringrequired0
- namestringrequired0
- linkedInUrlstringrequired0
- domainstring | nullrequired0
- websitestring | nullrequired0
- industrystring | nullrequired0
- logoUrlstring | nullrequired0
- employeeCountnumber | nullrequired0
- employeeRangestring | nullrequired0
- 0
- enrichmentStatusstringrequiredpendingenrichedfailed
- prospectCountnumberrequired0
- createdAtnumberrequired0
- updatedAtnumberrequired0
- descriptionstring | nullrequired0
- industriesarray of stringrequired0
- specialtiesarray of stringrequired0
- yearFoundednumber | nullrequired0
- companyTypestring | nullrequired0
- contactCountintegerrequired0
Contacts linked to this company, archived included.
ResponseMetaobject
Metadata on every success response.
- requestIdstringrequired0
- 0
- pagePageMeta0
Cursor pagination.
hasMoreis the only end signal; pages may be short. - dryRunboolean0
True only on a dry-run response (action operations).
ContactSummaryobject
A contact as listed. Documented fields are always present (null when empty).
- idstringrequired0
- firstNamestring | nullrequired0
- lastNamestring | nullrequired0
- emailstring | nullrequired0
- phonestring | nullrequired0
- linkedInUrlstring | nullrequired0
- titlestring | nullrequired0
- companystring | nullrequired0
Company name as captured on the contact.
- companyIdstring | nullrequired0
- locationstring | nullrequired0
- statusstringrequired
Sales stage.
enriching,enriched,qualified,excludedandfailedare legacy values still present on older contacts.newreadyincompletecontactedrepliedconvertedlostenrichingenrichedqualifiedexcludedfailed - sourcestring | nullrequired0
- scorenumber | nullrequired0
Best ICP score, 0 to 100.
- activityScorenumber | nullrequired0
- tagsarray of stringrequired0
- isArchivedbooleanrequired0
- connectionStatusstring | nullrequired0
LinkedIn connection status.
- createdAtnumberrequired0
Ms since epoch.
- updatedAtnumber | nullrequired0