Skip to content

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

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

Create enterprise group service

Request

Create a new enterprise-level group service.

Security
BearerAuth
Headers
company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd
Bodyapplication/jsonrequired
namestringrequired

Name.

Example: "example"
external_idstring

External id.

Example: "65f4c840b6f1a10012ab34cd"
category_idstring

Category id.

Example: "65f4c840b6f1a10012ab34cd"
descriptionstring

Description.

Example: "example"
colorstring

Color.

Example: "active"
durationinteger>= 0required

Duration.

Example: 20
duration_beforeinteger>= 0

Duration before.

Example: 20
duration_afterinteger>= 0

Duration after.

Example: 20
durations_patternArray of integersnon-emptyrequired

Durations pattern.

Example: [15]
pricenumber>= 0

Price.

Example: 19.9
has_online_paymentboolean

Has online payment.

Example: true
is_bookableboolean

Is bookable.

Example: true
is_stalledboolean

Is stalled.

Example: true
is_payment_mandatoryboolean

Is payment mandatory.

Example: true
max_participantsinteger>= 0

Max participants.

Example: 20
dependenciesstring

Dependencies.

Example: "example"
affected_branch_idsArray of stringsnon-empty

Affected branch ids.

Example: ["65f4c840b6f1a10012ab34cd"]
affected_branch_external_idsArray of stringsnon-empty

Affected branch external ids.

Example: ["65f4c840b6f1a10012ab34cd"]
maximum_lead_timestring

Maximum lead time.

Example: "09:30"
minimum_lead_timestring

Minimum lead time.

Example: "09:30"
cancellation_lead_timestring

Cancellation lead time.

Example: "09:30"
attributesstring

Attributes.

Example: "example"
extra_personsstring

Extra persons.

Example: "example"
locationobject

Location.

Example: {"key":"value"}
curl -i -X POST \
  https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-group-services \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd' \
  -d '{
    "name": "example",
    "external_id": "65f4c840b6f1a10012ab34cd",
    "category_id": "65f4c840b6f1a10012ab34cd",
    "description": "example",
    "color": "active",
    "duration": 20,
    "duration_before": 20,
    "duration_after": 20,
    "durations_pattern": [
      15
    ],
    "price": 19.9,
    "has_online_payment": true,
    "is_bookable": true,
    "is_stalled": true,
    "is_payment_mandatory": true,
    "max_participants": 20,
    "dependencies": "example",
    "affected_branch_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "affected_branch_external_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "maximum_lead_time": "09:30",
    "minimum_lead_time": "09:30",
    "cancellation_lead_time": "09:30",
    "attributes": "example",
    "extra_persons": "example",
    "location": {
      "key": "value"
    }
  }'

Responses

Creates new enterprise-level group service and returns created 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": "65f4c840b6f1a10012ab34cd",
    "externalId": "ext-course-001",
    "name": "Advanced Yoga Workshop",
    "description": "8-week intensive yoga program for intermediate practitioners",
    "duration": 60,
    "durationBefore": 10,
    "durationAfter": 5,
    "price": 299.99,
    "currency": "USD",
    "maxParticipants": 20,
    "minParticipants": 5,
    "isBookable": true,
    "isCourse": true,
    "categoryId": "65f5d950c7g2b20123bc45de",
    "categoryName": "Wellness & Fitness",
    "resourceIds": [ … ],
    "scheduleType": "RECURRING",
    "frequency": "WEEKLY",
    "color": "#00AA00",
    "orderIndex": 1,
    "createdAt": "2024-03-07T10:30:00Z",
    "updatedAt": "2024-03-07T10:30:00Z",
    "ts": 1709823000
  },
  "status": 1
}

List enterprise group services

Request

These are services like courses, workshops or events that are offered for more than 1 attendee.

Security
BearerAuth
Query
with_full_attributesboolean

Include full service attributes in the response (true or false).

Example: with_full_attributes=true
Headers
company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd
curl -i -X GET \
  'https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-group-services?with_full_attributes=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns list of enterprise-level group services (courses, workshops, events) with their details.

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": [
    { … },
    { … }
  ],
  "status": 1
}

List enterprise group service categories

Request

List enterprise group service categories.

Security
BearerAuth
Query
idsArray of stringsnon-empty

Filter categories by IDs. Comma-separated list of valid MongoDB IDs.

Example: ids=65f4c840b6f1a10012ab34cd
resource_idstring^[0-9a-f]{24}$

Filter categories by resource ID. Must be a valid MongoDB ID.

Example: resource_id=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/enterprise-group-services/categories?ids=65f4c840b6f1a10012ab34cd&resource_id=65f4c840b6f1a10012ab34cd&page=1&limit=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns list of enterprise-level group service categories with their details.

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
}

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