GET
/
company
/
get
/
{company_slug}
curl --request GET \
  --url https://api.hierarch.io/v1/company/get/{company_slug}/ \
  --header 'token: <api-key>'
{
  "slug": "<string>",
  "name": "<string>",
  "email": "<string>",
  "url": "<string>",
  "description": "<string>",
  "slogan": "<string>",
  "country": "<string>",
  "address": "<string>",
  "state_region": "<string>",
  "postcode": "<string>",
  "sector": "<string>",
  "industry": "<string>",
  "currency": "<string>",
  "logo": "<string>",
  "banner": "<string>",
  "thumbnail": "<string>",
  "datetime": "<string>",
  "skype": "<string>",
  "slack": "<string>",
  "whatsapp": "<string>",
  "msteams": "<string>",
  "discord": "<string>",
  "linkedin": "<string>",
  "github": "<string>",
  "facebook": "<string>",
  "instagram": "<string>",
  "twitter": "<string>",
  "pinterest": "<string>",
  "business_hour_start": "<string>",
  "business_hour_end": "<string>",
  "timezone": "<string>",
  "sunday": "<string>",
  "monday": "<string>",
  "tuesday": "<string>",
  "wednesday": "<string>",
  "thusrday": "<string>",
  "friday": "<string>",
  "saturday": "<string>"
}

Authorizations

token
string
header
required

API token provided to your company

Path Parameters

company_slug
string
required

This is your company url

Response

200
application/json
OK Response
slug
string
required

The company url

name
string

The name of the company

email
string

The email of the owner

url
string

Company website

description
string

Company description

slogan
string

Company slogan

country
string

Country where the company is based

address
string

Complete company address

state_region
string

State / Region

postcode
string

Postal code

sector
string

Business sector

industry
string

Industry that the company operates

currency
string

Currency used in transactions, e.g. USD

Company logo url

banner
string

Company banner url

thumbnail
string

Auto-generated - Company thumbnail url

datetime
string

Date and time the company was created

skype
string

Company skype account

slack
string

Company slack account

whatsapp
string

Company whatsapp account

msteams
string

Company msteams account

discord
string

Company discord account

linkedin
string

Company linkedin account

github
string

Company github account

facebook
string

Company facebook account

instagram
string

Company instagram account

twitter
string

Company X/twitter account

pinterest
string

Company pinterest account

business_hour_start
string

Start time for company operations

business_hour_end
string

Closing time for company operations

timezone
string

Timezone

sunday
string

true if company operates on Sunday

monday
string

true if company operates on Monday

tuesday
string

true if company operates on Tuesday

wednesday
string

true if company operates on Wednesday

thusrday
string

true if company operates on Thursday

friday
string

true if company operates on Friday

saturday
string

true if company operates on Saturday