Agent API

Business

2 endpoints.

GET/api/v1/agent/businesses/{business_id}

Get business details (agent)

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessProfileData_

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessProfileData

BusinessProfileData fields

Field Type Description

idrequired string

company_name string | null

year_founded integer | null

website_url string | null

tagline string | null

address

Address | null

Address fields

Field	Type	Description
`line1`	`string \| null`
`line2`	`string \| null`
`city`	`string \| null`
`state`	`string \| null`
`zip_code`	`string \| null`
`country`	`string \| null`

descriptions

Descriptions | null

Descriptions fields

Field	Type	Description
`company_description`	`string \| null`
`about`	`string \| null`
`mission_statement`	`string \| null`
`values`	`string[]`	string[] fields Nested object (not expanded)

contact_info

ContactInfo | null

ContactInfo fields

Field	Type	Description
`primary_phone`	`string \| null`
`primary_email`	`string \| null`
`support_email`	`string \| null`
`sales_email`	`string \| null`
`external_management_url`	`string \| null`

social_profiles

SocialProfiles | null

SocialProfiles fields

Field	Type	Description
`facebook`	`string \| null`
`instagram`	`string \| null`
`twitter`	`string \| null`
`linkedin`	`string \| null`
`youtube`	`string \| null`
`tiktok`	`string \| null`
`google_my_business`	`string \| null`
`pinterest`	`string \| null`
`yelp`	`string \| null`
`tripadvisor`	`string \| null`
`google_review`	`string \| null`

industries

BusinessIndustries | null

BusinessIndustries fields

Field	Type	Description
`primary`	`string \| null`
`secondary`	`string[]`	max items 5 string[] fields Nested object (not expanded)

terms_of_service_markdown string | null

privacy_policy_markdown string | null

is_active boolean default true

timezone string default "America/New_York"

timezone_source string default "default"

created_at integer | null

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.

PATCH/api/v1/agent/businesses/{business_id}

Update business profile (agent)

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonBusinessUpdateBody

Field	Type	Description
`company_name`	`string \| null`
`year_founded`	`integer \| null`
`website_url`	`string \| null`
`tagline`	`string \| null`
`address`	`Address \| null`	Address fields Address, expanded above.
`descriptions`	`Descriptions \| null`	Descriptions fields Descriptions, expanded above.
`contact_info`	`ContactInfo \| null`	ContactInfo fields ContactInfo, expanded above.
`social_profiles`	`SocialProfiles \| null`	SocialProfiles fields SocialProfiles, expanded above.
`industries`	`BusinessIndustries \| null`	BusinessIndustries fields BusinessIndustries, expanded above.
`terms_of_service_markdown`	`string \| null`
`privacy_policy_markdown`	`string \| null`
`is_active`	`boolean \| null`
`timezone`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessProfileData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`BusinessProfileData`	BusinessProfileData fields BusinessProfileData, 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.