CompanyList

List response for GET /companies.

items object[]required

Array [

iduuidrequired

nameNamerequired

country objectrequired

anyOf

• string
• null

string

currency objectrequired

anyOf

• string
• null

string

timezone objectrequired

anyOf

• string
• null

string

total_rooms objectrequired

anyOf

• integer
• null

integer

onboarded object

Onboarding progress flags for the Company (Sarucci-managed); partners read this to see how far data/integration setup has got.

anyOf

• string
• null

string

partner_id objectrequired

anyOf

• uuid
• null

uuid

created_atdate-timerequired

data_pipeline_inbox_emailData Pipeline Inbox Emailrequired

Send hotel data files (history & forecast, on-the-books, booking pace, cancellations, detailed availability) to this address — Sarucci's data pipeline parses incoming mail at this inbox and ingests the attachments for this Company.

Example: support+datareports_1b5f37df-2115-4517-88be-74db629889ac@sarucci.com

]

totalTotalrequired

CompanyList

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "country": "string",
      "currency": "string",
      "timezone": "string",
      "total_rooms": 0,
      "onboarded": "string",
      "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "data_pipeline_inbox_email": "support+datareports_1b5f37df-2115-4517-88be-74db629889ac@sarucci.com"
    }
  ],
  "total": 0
}