Keystone Developers
Open Keystone
API reference

Public API

Company information

1 endpoint.

GET/api/v1/public/company_information

Get company information

Company information for the authenticated business. 404 if business not found.

Parameters

NameInTypeDescription
X-API-Keyheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_PublicCompanyInformation_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredPublicCompanyInformation
PublicCompanyInformation fields
FieldTypeDescription
idrequiredstring
company_namestring | null
taglinestring | null
mission_statement_markdownstring | null
about_text_markdownstring | null
about_markdownstring | null
description_markdownstring | null
values_markdownstring | null
valuesPublicCompanyValue[]
PublicCompanyValue[] fields

PublicCompanyValue (not expanded)

stats_markdownstring | null
founded_yearinteger | null
business_hoursPublicBusinessHours | object | null
PublicBusinessHours | object | null fields
PublicBusinessHours

PublicBusinessHours (not expanded)

object
external_management_urlstring | null
portal_urlstring | null
primary_phonestring | null
primary_emailstring | null
address_line_1string | null
address_line_2string | null
citystring | null
statestring | null
zip_codestring | null
support_emailstring | null
sales_emailstring | null
facebook_urlstring | null
instagram_urlstring | null
tiktok_urlstring | null
linkedin_urlstring | null
twitter_urlstring | null
youtube_urlstring | null
pinterest_urlstring | null
google_my_business_urlstring | null
yelp_urlstring | null
tripadvisor_urlstring | null
google_reviews_urlstring | null
logo_photoPublicPhoto | null
PublicPhoto fields
FieldTypeDescription
thumbnail_urlstring | null
medium_urlstring | null
large_urlstring | null
original_urlstring | null
favicon_urlstring | null
photo_attachmentsPublicPhotoAttachment[]
PublicPhotoAttachment[] fields

PublicPhotoAttachment (not expanded)

account_statusstring | null
chat_enabledbooleandefault false
terms_of_service_markdownstring | null
privacy_policy_markdownstring | null
managed_phone_numbersany[]
any[] fields
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.