Console API

Accounts

11 endpoints.

POST/api/v1/admin/account-user-invites/{invite_id}/accept

Accept a pending account invite for the authenticated user

Parameters

Name	In	Type	Description
`invite_id`required	path	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AccountInviteConsumeData_

Field Type Description

request_idrequired string

success true default true

datarequired

AccountInviteConsumeData

AccountInviteConsumeData fields

Field Type Description

business_idrequired string

userrequired

AccountUserData

AccountUserData fields

Field	Type	Description
`id`required	`string`
`kind`required	`string`
`first_name`	`string`	default ""
`last_name`	`string`	default ""
`email`required	`string (email)`
`phone`	`string \| null`
`role`required	`string`
`status`required	`string`
`delivery_status`	`string \| null`
`joined_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/accounts

List admin account summaries

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AccountSummaryData__

Field Type Description

request_idrequired string

success true default true

datarequired

AccountSummaryData[]

AccountSummaryData[] fields

Field	Type	Description
`id`required	`string`
`business_name`required	`string`
`primary_industry`required	`string`
`secondary_industries`	`string[]`	string[] fields Nested object (not expanded)
`user_count`required	`integer`
`status`required	`string`
`created_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/accounts

Create account

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAccountCreateBody

Field Type Description

business_namerequired string

primary_industry_idrequired string

secondary_industry_ids

string[]

max items 5

string[] fields

primary_user

AccountPrimaryUserBody | null

AccountPrimaryUserBody fields

Field	Type	Description
`first_name`required	`string`
`last_name`required	`string`
`email`required	`string (email)`

Responses

201Successful Response

application/jsonSuccessResponse_AccountCreateData_

Field Type Description

request_idrequired string

success true default true

datarequired

AccountCreateData

AccountCreateData fields

Field	Type	Description
`account`required	`AccountSummaryData`	AccountSummaryData fields AccountSummaryData, expanded above.
`primary_user_id`	`string (uuid) \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/accounts/{business_id}/users

List account users and pending invites

Parameters

Name	In	Type	Description
`business_id`required	path	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AccountUserData__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AccountUserData[]`	AccountUserData[] fields AccountUserData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/accounts/{business_id}/users

Invite an account user (pending invite + email)

Parameters

Name	In	Type	Description
`business_id`required	path	`string`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAccountUserInviteBody

Field	Type	Description
`email`required	`string (email)`
`phone`	`string \| null`
`role`	`string`	default "Business User"

Responses

201Successful Response

application/jsonSuccessResponse_AccountUserData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AccountUserData`	AccountUserData fields AccountUserData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/admin/accounts/{business_id}/users/{entry_id}

Update an account user or pending invite

Parameters

Name	In	Type
`business_id`required	path	`string`
`entry_id`required	path	`string`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAccountUserUpdateBody

Field	Type	Description
`first_name`required	`string`
`last_name`required	`string`
`email`required	`string (email)`
`phone`	`string \| null`
`role`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AccountUserData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AccountUserData`	AccountUserData fields AccountUserData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/accounts/{business_id}/users/{entry_id}

Delete an account user link or pending invite

Parameters

Name	In	Type
`business_id`required	path	`string`
`entry_id`required	path	`string`
`authorization`	header	`string \| null`

Responses

204Successful Response

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/accounts/{business_id}/users/{entry_id}/resend

Re-send the invitation email for a pending invite

Parameters

Name	In	Type
`business_id`required	path	`string`
`entry_id`required	path	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AccountUserData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AccountUserData`	AccountUserData fields AccountUserData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/accounts/from-website

Create account from a website URL (streamlined onboarding)

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAccountCreateFromWebsiteBody

Field	Type	Description
`website_url`required	`string`
`primary_industry_id`	`string \| null`
`secondary_industry_ids`	`string[]`	max items 5 string[] fields
`primary_user`	`AccountPrimaryUserBody \| null`	AccountPrimaryUserBody fields AccountPrimaryUserBody, expanded above.
`user_prompt`	`string \| null`

Responses

201Successful Response

application/jsonSuccessResponse_AccountCreateFromWebsiteData_

Field Type Description

request_idrequired string

success true default true

datarequired

AccountCreateFromWebsiteData

AccountCreateFromWebsiteData fields

Field	Type	Description
`account`required	`AccountSummaryData`	AccountSummaryData fields AccountSummaryData, expanded above.
`primary_user_id`	`string (uuid) \| null`
`scrape_run_id`required	`string`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/me/businesses

List businesses linked to the authenticated user

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_MyBusinessSummary__

Field Type Description

request_idrequired string

success true default true

datarequired

MyBusinessSummary[]

MyBusinessSummary[] fields

Field	Type	Description
`id`required	`string`
`business_name`required	`string`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/me/businesses

Create the authenticated user's own business (self-serve onboarding)

Beside GET /me/businesses on purpose: `/api/v1/admin` is the console BFF's prefix, not an admin-only surface, and the router's subscription gate no-ops without a `business_id` in the path — a user with no subscribed business must be able to create one. Always 200; `created` says whether this call made the business or returned the one the caller already had (see the service).

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonMyBusinessCreateBody

Field	Type	Description
`business_name`required	`string`
`website_url`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_MyBusinessCreateData_

Field Type Description

request_idrequired string

success true default true

datarequired

MyBusinessCreateData

MyBusinessCreateData fields

Field	Type	Description
`business`required	`MyBusinessSummary`	MyBusinessSummary fields MyBusinessSummary, expanded above.
`created`required	`boolean`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.