Get Company Info - Roosted HR API Documentation

GET

company

info

Get Company Info

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/company/info \
  --header 'X-API-KEY: <api-key>'

{
  "name": "My Company",
  "primary_contact": "John Doe",
  "contact_number": "+123456789",
  "contact_email": "email@my-company.com",
  "address": "Turner str. 10",
  "city": "Baltimore",
  "zip": "12345",
  "timezone": {
    "id": 5,
    "name": "Eastern Time (US & Canada)",
    "offset": "-05:00"
  },
  "country": {
    "id": 2,
    "name": "United States"
  }
}

This endpoint returns general company profile information including name, contact details, and address.

For HR contact details, use the Get Company HR Info endpoint.

Authorizations

X-API-KEY

string

header

required

Response

name

string

Company name

primary_contact

string

Primary contact person name

contact_number

string

Primary contact phone number

contact_email

string

Primary contact email address

address

string

Company street address

city

string

Company city

zip

string

Company postal/ZIP code

timezone

object

Company timezone

Show child attributes

country

object

Company country

Show child attributes

Edit Company InfoThis endpoint serves the purpose of modifying company information.

Get Company Info

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/company/info \
  --header 'X-API-KEY: <api-key>'

{
  "name": "My Company",
  "primary_contact": "John Doe",
  "contact_number": "+123456789",
  "contact_email": "email@my-company.com",
  "address": "Turner str. 10",
  "city": "Baltimore",
  "zip": "12345",
  "timezone": {
    "id": 5,
    "name": "Eastern Time (US & Canada)",
    "offset": "-05:00"
  },
  "country": {
    "id": 2,
    "name": "United States"
  }
}