Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Provide your API key in the x-api-key header.

Body

application/json
domain
string
required

The account's domain, as listed in accounts[].domain.

Example:

"pennylane.com"

scope
string

Which CRM book to rank: omit it for the API key holder's own accounts (their linked CRM owner), all for every account with a domain, unassigned for accounts nobody owns (HubSpot only), or a CRM owner id from GET /todays-accounts/owners.

reason
enum<string>

Why the account is skipped; BAD_TIMING when omitted.

Available options:
BAD_TIMING,
IN_PROGRESS,
NOT_ICP,
WRONG_CONTACT,
OTHER
Example:

"IN_PROGRESS"

Response

The book's list, whatever its status

status
enum<string>

none: never ranked, call refresh. pending: ranking, poll again.

Available options:
none,
pending,
ended,
error
scope
string | null

The book: all, unassigned, owner:<CRM owner id>, or unlinked:<user id> when the caller has no CRM owner.

crm
enum<string> | null
Available options:
hubspot,
salesforce
requested_at
string<date-time> | null
generated_at
string<date-time> | null
error
string | null
owner_linked
boolean | null

False when the caller's own book was asked and no CRM owner matches their email.

book_size
integer | null

Accounts with a domain in the book.

accounts
object[]