Owlbound
Browse the docs

Reference · 1 operations

Identities

The workspace's sending identities.

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

identities.list

List the workspace's sending identities.

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

Each identity is a team member's sender profile with its connected channels (LinkedIn, email, WhatsApp), health and daily limits. Credentials, provider account ids and provider error text are never returned. Cursor-paginated.

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 identities.
Show schema

IdentityListResponse

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 · 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/identities" \
  -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.

Identityobject

A team member's sending identity.

  • idstringrequired
    0
  • memberNamestringrequired
    0
  • isActivebooleanrequired
    0
  • linkedInProfileUrlstring | nullrequired
    0
  • channelsarray of IdentityChannelrequired
    0
  • healthStatusobject | nullrequired
    0
    + Show child fields
    • statusstringrequired
      healthywarningerrordisconnected
    • lastSuccessfulActionnumber | nullrequired
      0
    • lastHealthChecknumber | nullrequired
      0
  • dailyLimitsobject | nullrequired
    0
    + Show child fields
    • connectionRequestsnumberrequired
      0
    • messagesnumberrequired
      0
    • emailsnumberrequired
      0
  • createdAtnumberrequired
    0
  • updatedAtnumberrequired
    0
IdentityChannelobject

A connected sending account. No credentials or provider ids.

  • channelstringrequired
    linkedinemailwhatsapp
  • providerstringrequired
    linkedingmailoutlookwhatsapp
  • statusstringrequired
    activereconnectingdisconnectederror
  • namestring | nullrequired
    0
  • emailstring | nullrequired

    Sending address, email channels only.

    0
  • linkedInUrlstring | nullrequired

    LinkedIn channels only.

    0
  • connectedAtnumberrequired
    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

← All operations