Workspace Company Profile
GET
/api/v1/workspaces/{workspaceId}/company-profile
Scope workspace:read
Read the workspace company profile: legal name, address, tax id, bank details, social links, and brand colors.
Pfad
workspaceIdPflicht
string
Workspace that owns the resource.
Antworten
200WorkspaceCompanyProfileDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Workspace company profile.
idPflicht
string (uuid)
Identifier.
workspaceIdPflicht
string (uuid)
Workspace that owns this.
legalName
string
Name of the legal.
legalForm
string
Legal form.
street
string
Street.
houseNumber
string
House number.
postalCode
string
Postal code.
city
string
City.
countryCodePflicht
string
Country code.
vatId
string
Identifier of the vat.
taxNumber
string
Tax number.
commercialRegisterNumber
string
Commercial register number.
commercialRegisterCourt
string
Commercial register court.
website
string
Website.
phone
string
Phone.
email
string
Email address.
linkedInUrl
string
URL of the linked in.
xingUrl
string
URL of the xing.
facebookUrl
string
URL of the facebook.
instagramUrl
string
URL of the instagram.
xUrl
string
URL of the x.
youTubeUrl
string
URL of the you tube.
iban
string
Iban.
bic
string
Bic.
bankName
string
Name of the bank.
accountHolder
string
Account holder.
primaryColorHex
string
Primary color hex.
secondaryColorHex
string
Secondary color hex.
accentColorHex
string
Accent color hex.
accentColorsPflicht
string[]
Accent colors.
additionalBrandColorsPflicht
string[]
Additional brand colors.
fontFamily
string
Font family.
hasLogoPflicht
boolean
Whether logo is set.
logoUrl
string
URL of the logo.
hasFaviconPflicht
boolean
Whether favicon is set.
faviconUrl
string
URL of the favicon.
stripeVatSyncWarning
string
Warning when the VAT identifier could not be updated.