Company

Get company info

Changed on

Get company info by id

get/api/v1/company/{company_id}

Request

Path parameters

company_idstring uuid required

Response

Successful Response

namestring required

The name of the company

descriptionstring nullable

The description of the company

websitestring nullable

The website of the company

contactEmailstring nullable

The contact of the company

phonestring nullable

The phone number of the company

telegramAccountstring nullable

The telegram account of the company

extendyEnabledboolean

Turn Extendy push integration on/off for this company. Omit to leave unchanged on update.

idstring uuid required

The unique identifier of the company

createdAtstring date-time required

The date and time when the company was created

updatedAtstring date-time nullable

The date and time when the company was last updated

logoUrlstring nullable

The URL of the company's logo

Example response

{
  "contact_email": "example@ex.com",
  "created_at": "2024-01-15T10:30:00Z",
  "description": "A leading company in tech innovation, specializing in AI and IoT solutions.",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "logo_url": "https://www.techinnovators.com/logo.png",
  "name": "Tech Innovators Inc.",
  "phone": "+1234567890",
  "telegram_account": "@techinnovators",
  "updated_at": "2024-01-15T10:30:00Z",
  "website": "https://www.techinnovators.com"
}

Changes