Console API

Industry

6 endpoints.

GET/api/v1/admin/businesses/{business_id}/industries

Get business's primary and secondary industry

Get business's primary and secondary industry (resolved to full industry data). 404 if business not found.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_BusinessIndustriesData_

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessIndustriesData

BusinessIndustriesData fields

Field Type Description

primary

IndustryData | null

IndustryData fields

Field	Type	Description
`id`required	`string`
`industry_name`required	`string`
`industry_description`	`string \| null`
`industry_short_description`	`string \| null`
`accounts_count`	`integer`	default 0
`stock_photos_count`	`integer`	default 0
`updated_at`required	`integer`

secondary

IndustryData[]

default []

IndustryData[] fields

IndustryData (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

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/admin/businesses/{business_id}/industries

Update primary and/or secondary industry of business

Update primary and/or secondary industry. 404 if business not found.

Parameters

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

Request bodyrequired

application/jsonBusinessIndustriesPatchBody

Field	Type	Description
`primary`	`string \| null`
`secondary`	`string[] \| null`	string[] \| null fields

Responses

200Successful Response

application/jsonSuccessResponse_BusinessIndustriesData_

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

GET/api/v1/admin/industries

List all industries

Get list of all industries (ordered by name).

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_list_IndustryData__

Field Type Description

request_idrequired string

success true default true

datarequired

IndustryData[]

IndustryData[] fields

IndustryData, expanded above.

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

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/industries

Create industry

Create an industry with client-provided id.

Returns 201 on create; 409 when the industry id already exists.

Parameters

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

Request bodyrequired

application/jsonIndustryCreateBody

Field	Type	Description
`id`	`string \| null`
`name`required	`string`
`description`required	`string`

Responses

201Successful Response

application/jsonSuccessResponse_IndustryData_

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

GET/api/v1/admin/industries/{industry_id}

Get industry by industry ID

Get one industry by id. 404 if missing.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_IndustryDetailsData_

Field Type Description

request_idrequired string

success true default true

datarequired

IndustryDetailsData

IndustryDetailsData fields

Field	Type	Description
`id`required	`string`
`industry_name`required	`string`
`industry_description`	`string \| null`
`industry_short_description`	`string \| null`
`accounts_count`	`integer`	default 0
`stock_photos_count`	`integer`	default 0
`updated_at`required	`integer`
`created_at`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.

PATCH/api/v1/admin/industries/{industry_id}

Update industry details

Partially update industry name and descriptions. 404 if industry not found.

Parameters

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

Request bodyrequired

application/jsonIndustryPatchBody

Field	Type	Description
`industry_name`	`string \| null`
`industry_description`	`string \| null`
`industry_short_description`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_IndustryData_

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