Get Company

GET 
/api/company

Get Company

Request

Header Parameters

X-Company-Slug stringrequired

Responses

200

Successful response

application/json

Schema

Schema

id stringrequired
whitelabel_id numberrequired
code stringrequired
slug stringrequired

Possible values: <= 25 characters

name stringrequired
about stringnullablerequired
address stringnullablerequired
email stringnullablerequired
created_at stringrequired
updated_at stringrequired
country_id numbernullablerequired
package_id numberrequired
valid_until stringrequired
phone numbernullablerequired
full_phone numbernullablerequired
cf_vendor objectnullablerequired
cf_customer objectnullablerequired
settings objectnullablerequired
cf_reservation objectnullablerequired
modules string[]nullablerequired
city stringnullablerequired

working_hours

object

monday stringnullable

tuesday stringnullable

wednesday stringnullable

thursday stringnullable

friday stringnullable

saturday stringnullable

sunday stringnullable
last_payment date-timerequired
employees object[]required

package

object

required

id numberrequired

name stringrequired

price numberrequired

currency stringrequired

whitelabel_id numberrequired

modules string[]nullablerequired

created_at date-timerequired

updated_at date-timerequired

interval stringnullablerequired

Possible values: [yearly, monthly]

type stringnullablerequired

Possible values: [subscription, email, sms]

code stringrequired

quantity numberrequired

Example (from schema)

{
  "id": "string",
  "whitelabel_id": 0,
  "code": "string",
  "slug": "string",
  "name": "string",
  "about": "string",
  "address": "string",
  "email": "string",
  "created_at": "string",
  "updated_at": "string",
  "country_id": 0,
  "package_id": 0,
  "valid_until": "string",
  "phone": 0,
  "full_phone": 0,
  "cf_vendor": {},
  "cf_customer": {},
  "settings": {},
  "cf_reservation": {},
  "modules": [
    "string"
  ],
  "city": "string",
  "working_hours": {
    "monday": "07:30-18:00",
    "tuesday": "07:30-18:00",
    "wednesday": "07:30-18:00",
    "thursday": "07:30-18:00",
    "friday": "07:30-18:00",
    "saturday": "07:30-18:00",
    "sunday": "07:30-18:00"
  },
  "last_payment": "2024-08-12T09:09:28.121Z",
  "employees": [
    {
      "id": "1",
      "email": "[email protected]",
      "name": "Test",
      "surname": "User 1",
      "language": "en",
      "phone_number": "+90123123213",
      "remember_me_token": true,
      "birthday": "1990-01-01",
      "created_at": "2024-02-20T19:18:45.782+03:00",
      "updated_at": "2024-04-11T01:11:24.889+03:00",
      "timezone": "Europe/Istanbul",
      "meta": {
        "pivot_working_hours": {
          "monday": "07:30-18:00",
          "tuesday": "07:30-18:00",
          "wednesday": "07:30-18:00",
          "thursday": "07:30-18:00",
          "friday": "07:30-18:00",
          "saturday": "07:30-18:00",
          "sunday": "07:30-18:00"
        },
        "pivot_company_id": "string",
        "pivot_user_id": "string",
        "pivot_is_admin": true,
        "pivot_is_active": true,
        "pivot_created_at": "string",
        "pivot_updated_at": "string"
      }
    }
  ],
  "package": {
    "id": 0,
    "name": "string",
    "price": 0,
    "currency": "string",
    "whitelabel_id": 0,
    "modules": [
      "string"
    ],
    "created_at": "2024-08-12T09:09:28.122Z",
    "updated_at": "2024-08-12T09:09:28.122Z",
    "interval": "yearly",
    "type": "subscription",
    "code": "string",
    "quantity": 0
  }
}

Loading...