Skip to main content
Get Company Profile

Authorizations

Authorization
string
header
required

Send an active organization API key in the Authorization: Bearer header.

Headers

Idempotency-Key
string | null

Body

application/json

A company's domain, or any URL on its site, to refresh the profile of.

domain
string
required

A bare domain or any URL on the company's site

Required string length: 1 - 8192
styleguide
boolean
default:false

Add the measured styleguide for 5 more credits

timeout
integer
default:30000

Milliseconds the whole request may take

Required range: x <= 120000

Response

Successful Response

data
CompanyProfileResponse · object | null
required

A company profile read from its own website in this request. Fields without a signal stay null or empty.

message
string | null
required
meta
Meta · object | null
required
request_id
string | null
required
success
boolean
default:true
required