Companies

Auth

Endpoints from auth routes module.

Operations

Appointments

Endpoints from appointments routes module.

Operations

Availability

Endpoints from availability routes module.

Operations

Booker Services

Endpoints from booker-services routes module.

Operations

Timeshifts

Endpoints from timeshifts routes module.

Operations

Customers

Endpoints from customers routes module.

Operations

Enterprise Customers

Endpoints for enterprise-level customer management.

Operations

Companies

Endpoints from companies routes module.

Operations

List all companies

Request

This endpoint fetches company data. This endpoint can be used in the app context (with app token) or company context (by the client with its company token) Only one of the following parameters is required: - company_id - enterprise_id - external_company_id If you want to filter by service_id or external_service_id it is mandatory to provide at least one parameter from the previous list.

Security

BearerAuth

Query

company_idstring^[0-9a-f]{24}$

Filter companies by company ID. Must be a valid MongoDB ID.

Example: company_id=65f4c840b6f1a10012ab34cd

enterprise_idstring^[0-9a-f]{24}$

Filter companies by enterprise ID. Must be a valid MongoDB ID.

Example: enterprise_id=65f4c840b6f1a10012ab34cd

enterprise_slugstring

Filter companies by enterprise slug (text identifier).

external_company_idstring

Filter companies by external company ID.

Example: external_company_id=ext-company-001

service_idstring^[0-9a-f]{24}$

Filter companies by service ID. Must be a valid MongoDB ID.

Example: service_id=65f4c840b6f1a10012ab34cd

external_service_idstring

Filter companies by external service ID.

Example: external_service_id=ext-service-001

enterprise_tag_idsArray of stringsnon-empty

Filter companies by enterprise tag IDs. Comma-separated list of valid MongoDB IDs.

Example: enterprise_tag_ids=65f4c840b6f1a10012ab34cd

enterprise_tag_external_idsArray of stringsnon-empty

Filter companies by enterprise tag external IDs. Comma-separated list of external identifiers.

Example: enterprise_tag_external_ids=ext-tag-001

fieldsArray of stringsnon-empty

Select which company fields to include in the response (comma-separated list).

Example: fields=65f4c840b6f1a10012ab34cd

company-idstring

Filter companies by company ID (alternative naming format).

enterprise-idstring

Filter companies by enterprise ID (alternative naming format).

enterprise-slugstring

Filter companies by enterprise slug (alternative naming format).

external-company-idstring

Filter companies by external company ID (alternative naming format).

service-idstring

Filter companies by service ID (alternative naming format).

external-service-idstring

Filter companies by external service ID (alternative naming format).

enterprise-tag-idsstring

Filter companies by enterprise tag IDs (alternative naming format).

enterprise-tag-external-idsstring

Filter companies by enterprise tag external IDs (alternative naming format).

owner_emailstring(email)

Filter companies by owner email address.

Example: owner_email=alex@example.com

external_company_idsArray of stringsnon-empty

Filter companies by external company IDs. Comma-separated list of external identifiers.

Example: external_company_ids=ext-company-001

company_idsArray of stringsnon-empty

Filter companies by company IDs. Comma-separated list of valid MongoDB IDs.

Example: company_ids=65f4c840b6f1a10012ab34cd

pageinteger>= 1

Page number (1-based).

Default 1

Example: page=1

limitinteger>= 1

Maximum items per page. Default: 10000 (when not provided or when provided value ≤ 0).

Default 10000

Example: limit=50

Headers

company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd

curl -i -X GET \
  'https://docs2.timify.com/_mock/apis/openapi/v1/companies?company_id=65f4c840b6f1a10012ab34cd&enterprise_id=65f4c840b6f1a10012ab34cd&enterprise_slug=string&external_company_id=ext-company-001&service_id=65f4c840b6f1a10012ab34cd&external_service_id=ext-service-001&enterprise_tag_ids=65f4c840b6f1a10012ab34cd&enterprise_tag_external_ids=ext-tag-001&fields=65f4c840b6f1a10012ab34cd&company-id=string&enterprise-id=string&enterprise-slug=string&external-company-id=string&service-id=string&external-service-id=string&enterprise-tag-ids=string&enterprise-tag-external-ids=string&owner_email=alex%40example.com&external_company_ids=ext-company-001&company_ids=65f4c840b6f1a10012ab34cd&page=1&limit=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns paginated list of companies with their details, filtered by provided criteria.

Bodyapplication/json

dataArray of objects(GenericRecord)required

List payload.

Example: [{"id":"65f4c840b6f1a10012ab34cd","externalId":"ext_1001","firstName":"John","lastName":"Doe","fullName":"John Doe","email":"john@example.com","totalBookings":5,"createdAt":"2024-01-15T10:30:00Z","updatedAt":"2024-02-20T14:45:30Z","ts":1708430730},{"id":"65f4c840b6f1a10012ab34ce","externalId":"ext_1002","firstName":"Jane","lastName":"Smith","fullName":"Jane Smith","email":"jane@example.com","totalBookings":3,"createdAt":"2024-01-20T11:15:00Z","updatedAt":"2024-02-25T13:22:00Z","ts":1708516200}]

data[].property name*anyadditional property

metaobject(ApiMeta)

totalinteger

Total count used by legacy list endpoints.

Example: 182

statusinteger

Operation status flag.

Example: 1

Response

application/json

{
  "data": [
    { … },
    { … }
  ],
  "total": 2,
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 2,
    "totalPages": 1
  },
  "status": 1
}

Toggle online status of the company

Request

If it is currently activated, it will be deactivated and vice versa.

Security

BearerAuth

Headers

company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd

curl -i -X PUT \
  https://docs2.timify.com/_mock/apis/openapi/v1/companies/onlinestatus \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Updates online booking status for the company and returns status confirmation.

Bodyapplication/json

dataobject(GenericRecord)

Generic response data object for proxied GraphQL entities.

Example: {"id":"65f4c840b6f1a10012ab34cd","externalId":"ext_1001","name":"Demo value"}

statusinteger

Operation status flag.

Example: 1

Response

application/json

{
  "data": {
    "id": "65f4c840b6f1a10012ab34cd",
    "slug": "main-salon",
    "name": "Main Salon",
    "onlineBookingEnabled": false,
    "updatedAt": "2024-03-07T14:22:15Z",
    "ts": 1709823735
  },
  "status": 1
}

Fetch company statistics

Request

Return aggregate booking and usage statistics for the company.

Security

BearerAuth

Query

monthstring

Filter statistics by month (format: MM or 1-12).

yearstring

Filter statistics by year (format: YYYY).

statistics_modestring

Statistics aggregation mode (e.g., DAILY, MONTHLY, YEARLY).

pageinteger>= 1

Page number (1-based).

Default 1

Example: page=1

limitinteger>= 1

Maximum items per page. Default: 10000 (when not provided or when provided value ≤ 0).

Default 10000

Example: limit=50

Headers

company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd

curl -i -X GET \
  'https://docs2.timify.com/_mock/apis/openapi/v1/companies/statistics?month=string&year=string&statistics_mode=string&page=1&limit=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns company statistics and metrics including usage data and performance indicators.

Bodyapplication/json

dataArray of objects(GenericRecord)required

List payload.

Example: [{"id":"65f4c840b6f1a10012ab34cd","externalId":"ext_1001","firstName":"John","lastName":"Doe","fullName":"John Doe","email":"john@example.com","totalBookings":5,"createdAt":"2024-01-15T10:30:00Z","updatedAt":"2024-02-20T14:45:30Z","ts":1708430730},{"id":"65f4c840b6f1a10012ab34ce","externalId":"ext_1002","firstName":"Jane","lastName":"Smith","fullName":"Jane Smith","email":"jane@example.com","totalBookings":3,"createdAt":"2024-01-20T11:15:00Z","updatedAt":"2024-02-25T13:22:00Z","ts":1708516200}]

data[].property name*anyadditional property

metaobject(ApiMeta)

totalinteger

Total count used by legacy list endpoints.

Example: 182

statusinteger

Operation status flag.

Example: 1

Response

application/json

{
  "data": [
    { … },
    { … }
  ],
  "total": 2,
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 2,
    "totalPages": 1
  },
  "status": 1
}

Enterprises

Endpoints from enterprises routes module.

Operations

Permissions

Endpoints from permissions routes module.

Operations

Services

Endpoints from services routes module.

Operations

Enterprise Services

Endpoints for enterprise-level service management.

Operations

Group Services

Endpoints from group-services routes module.

Operations

Enterprise Group Services

Endpoints from group-services-enterprise routes module.

Operations

Resources

Endpoints from resources routes module.

Operations

Enterprise Resource Categories

Endpoints for enterprise-level resource categories.

Operations

Notifications

Endpoints from notifications routes module.

Operations

Files

Endpoints from files routes module.

Operations

ICS

Endpoints from ics routes module.

Operations

Statistics

Endpoints from statistics routes module.

Operations

Transactions

Endpoints from transactions routes module.

Operations

Public

Endpoints from public routes module.

Operations

Auth

Appointments

Availability

Booker Services

Timeshifts

Customers

Enterprise Customers

Companies

List all companies

Request

Responses

Was this helpful?

Toggle online status of the company

Request

Responses

Was this helpful?

Fetch company statistics

Request

Responses

Was this helpful?

Enterprises

Permissions

Services

Enterprise Services

Group Services

Enterprise Group Services

Resources

Enterprise Resource Categories

Notifications

Files

ICS

Tags

Statistics

Transactions

Public