Skip to content
/
Reserve a booking in the...

TIMIFY Developer API GraphQL Proxy (0.0.4)

HTTP proxy API in front of TIMIFY GraphQL services. Generated from Express routes and route analysis docs.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
TIMIFY API Team
developers@timify.com
Languages
Servers
Mock server
https://docs2.timify.com/_mock/apis/openapi
Production
https://api.timify.com
Staging
https://api-stg.timify.com
Local development
http://localhost:3030

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

It returns the public information of an enterprise

Request

Data for an enterprise and branches that are online bookable. At least one of the following fields are required: - enterprise_id - enterprise_slug

Security
BookerSecretAuth
curl -i -X GET \
  https://docs2.timify.com/_mock/apis/openapi/v1/booker-services/enterprise \
  -H 'bs-authorization: YOUR_API_KEY_HERE'

Responses

Returns enterprise booking configuration and available services.

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": "beauty-spa-chain",
    "name": "Beauty & Spa Chain",
    "description": "Premier beauty and wellness services",
    "defaultBrandColor": "#FF6B9D",
    "logo": "https://cdn.example.com/logo.png",
    "website": "https://beautyandspacha.com",
    "phone": "+1-555-0789",
    "email": "hello@beautyspa.com",
    "onlineBookingEnabled": true,
    "branches": [ … ]
  },
  "status": 1
}

Reserve a booking in the system

Request

Reserve an appointment for a timeslot in the future. A reserved appointment needs to be confirmed

Security
BookerSecretAuth
curl -i -X POST \
  https://docs2.timify.com/_mock/apis/openapi/v1/booker-services/reservations \
  -H 'bs-authorization: YOUR_API_KEY_HERE'

Responses

Creates reservation for a service and returns reservation record with assigned ID.

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": "65f5d951c7g2b20123bc45df",
    "serviceId": "65f6e062d8h3c31234cd56eg",
    "serviceName": "Hair Cut",
    "companyId": "65f4c840b6f1a10012ab34cd",
    "startDate": "2024-03-18T09:00:00Z",
    "duration": 60,
    "resourceId": "65f8g284f0j5e53456ef78gi",
    "resourceName": "Station 1",
    "status": "RESERVED",
    "reservationCode": "RES-20240307-001",
    "expiresAt": "2024-03-08T09:00:00Z",
    "createdAt": "2024-03-07T10:30:00Z",
    "ts": 1709823000
  },
  "status": 1
}

Delete a reservation or an appointment

Request

An appointment or reservation is only deleteable within a certain time period.

Security
BookerSecretAuth
Path
reservationIdstringrequired

Reservationid path parameter.

Example: 65f4c840b6f1a10012ab34cd
curl -i -X DELETE \
  https://docs2.timify.com/_mock/apis/openapi/v1/booker-services/reservations/65f4c840b6f1a10012ab34cd \
  -H 'bs-authorization: YOUR_API_KEY_HERE'

Responses

Confirms deletion of the reservation and returns the deleted reservation record.

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": "65f5d951c7g2b20123bc45df",
    "serviceId": "65f6e062d8h3c31234cd56eg",
    "serviceName": "Hair Cut",
    "startDate": "2024-03-18T09:00:00Z",
    "status": "CANCELLED",
    "cancelledAt": "2024-03-07T11:15:30Z",
    "cancellationReason": "Customer requested cancellation",
    "ts": 1709823330
  },
  "status": 1
}

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

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

Tags

Endpoints from tags routes module.

Operations

Statistics

Endpoints from statistics routes module.

Operations

Transactions

Endpoints from transactions routes module.

Operations

Public

Endpoints from public routes module.

Operations