W3lcome API
  • Introduction
  • FAQ
  • Authentication
  • Changelog
  • Host
    • The Host Object
    • Retrieve a Host
    • Retrieve a List of Hosts
    • Insert a Host
    • Update a Host
    • Delete a Host
  • Visit
    • The Visit Object
    • Retrieve a Visit
    • Retrieve a List of Visits
    • Change Visit Status
    • Check-out a Visit
    • Check-in with Invitee Id
    • Check-out with Invitee Id
    • Delete a Visit
  • Blocked list
    • The Blocked List Object
    • Retrieve a Person on the Blocked List
    • Retrieve a List of People from the Blocked List
    • Insert a Person on the Blocked List
    • Update a Person on the Blocked List
    • Delete a Person from the Blocked List
  • Invitee
    • The Invitee Object
    • Retrieve an Invitee
    • Retrieve a List of Invitees
    • Insert an Invitee
    • Update an Invitee
    • Delete an Invitee
  • Delivery
    • The Delivery Object
  • Meeting
    • The Meeting Object
  • Notification
    • The Notification Object
  • Webhook
    • Webhook Endpoints
  • Company
    • The Company Object
    • Retrieve Company Information
    • Company Fields
  • Integration
    • W-Access
    • SBT
    • SBT QRCodes
    • Workplace by Facebook
Powered by GitBook
On this page
  • The Object
  • Short Sample
  • Available Methods

Was this helpful?

  1. Company

The Company Object

The Object

Attribute

Description

*id string required

It is a UUID v4 (36 characters long) automatically generated

*name string required

The name of the company

*lang string required

The current language used. It can be en, pt-BR or de

city string

City of the company

state string

State of the company

country string

Country of the company

address string

Address of the company

location string

Type of the company's location. E.g.: Headquarter

complement string

pictureUrl string

Company's logo

*timezone string required

Short Sample

{
    "name": "W3lcome",
    "lang": "pt-BR",
    "city": "Maringá",
    "state": "Paraná",
    "country": "Brazil",
    "address": "Av. Pedro Taques, 294",
    "location": "Headquarter",
    "timezone": "America/Sao_Paulo",
    "complement": "2º andar",
    "id": "3ace5db3-8b2e-433f-b2ce-0b72852d0d89"
}

Available Methods

  • GET /v1/company

PreviousWebhook EndpointsNextRetrieve Company Information

Last updated 4 years ago

Was this helpful?

The timezone of the company.

List of all timezones