Skip to content
/
Retrieve free bookable da...

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

Create booking with reservation ID

Request

Confirm a reservation and convert it into a full appointment with customer data.

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

Responses

Confirms reservation and creates appointment, returns confirmation with appointment details.

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",
    "reservationId": "65f5d951c7g2b20123bc45df",
    "startDate": "2024-03-15T14:00:00Z",
    "duration": 60,
    "serviceId": "65f6e062d8h3c31234cd56eg",
    "serviceName": "Hair Cut",
    "customerId": "65f7f173e9i4d42345de67fh",
    "customerName": "John Doe",
    "customerEmail": "john.doe@example.com",
    "resourceId": "65f8g284f0j5e53456ef78gi",
    "resourceName": "Station 1",
    "confirmationCode": "BOOK-20240315-001",
    "status": "CONFIRMED",
    "createdAt": "2024-03-07T10:30:00Z",
    "ts": 1709823000
  },
  "status": 1
}

Retrieve free bookable dates and times of a specific service or a group service

Request

Bookable timeslots for a service or group service. There are two ways to request company information: 1. company_id parameter 2. external_company_id with enterprise_id parameters Response parameters: - keys 'data.calendarBegin' and 'data.calendarEnd' - this is the allowed period for the availability algorithm. Can be adjusted in the web app under the section 'Booking setup' - key 'data.onDays' - array of dates with available time slots - key 'data.offDays' - array of dates that are fully booked - key 'data.slots.times' - array of times that are available for appointments To see the open slots for specific days, use the days[] parameter. When the service_id is present the service object is returned in the response. When the course_id is present the course object is returned in the response.

Security
BookerSecretAuth
Query
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
curl -i -X GET \
  'https://docs2.timify.com/_mock/apis/openapi/v1/booker-services/availabilities?page=1&limit=50' \
  -H 'bs-authorization: YOUR_API_KEY_HERE'

Responses

Returns available time slots for services based on provided date/time and resource filters.

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": 1,
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1
  },
  "status": 1
}

Check if an Appointment can be cancelled or reprogrammed.

Request

Check the status of the appointment, if the appointment can be cancelled or rescheduled.

Security
BookerSecretAuth
Query
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
curl -i -X GET \
  'https://docs2.timify.com/_mock/apis/openapi/v1/booker-services/booking-status?page=1&limit=50' \
  -H 'bs-authorization: YOUR_API_KEY_HERE'

Responses

Returns booking status and information for the specified service.

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": 1,
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1
  },
  "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