Keystone Developers

API reference

Edits API

Businesses

1 endpoint.

GET/api/v1/edits/businesses

Find businesses by name, site or domain, marked with whether the caller can edit them

Parameters

Name	In	Type	Description
`q`required	query	`string`
`limit`	query	`integer`	default 10
`authorization`	header	`string \| null`
`X-Internal-Api-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_BusinessMatchData__

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessMatchData[]

BusinessMatchData[] fields

Field	Type	Description
`business_id`required	`string`
`company_name`required	`string`
`website_url`	`string \| null`
`city`	`string \| null`
`state`	`string \| null`
`custom_domain`	`string \| null`
`preview_domain`	`string \| null`
`launched`required	`boolean`
`claim`	`ClaimData \| null`	ClaimData fields ClaimData (not expanded)
`editable`required	`boolean`
`locked_reason`	`string \| 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.