Skip to content
/
Fetch enterprise group se...

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

Delete enterprise group service

Request

The URL parameter "serviceId" can be used in two ways: - use the unique ID of the service assigned by TIMIFY ("serviceId"). In this case, you don't need the QUERY parameter "external" - use the "externalId" that you added to this service. In this case, you need to add the parameter "external" ( for ex.: /?external=1) so the Developer API will search by your "externalId" and not by "serviceId" assigned by TIMIFY You can add "externalId" to the service with the Developer API endpoints POST /services and PATCH /service/:serviceId

Security
BearerAuth
Path
groupServiceIdstringrequired

Groupserviceid path parameter.

Example: 65f4c840b6f1a10012ab34cd
Query
externalboolean

When set to 1, the path ID parameter is treated as an externalId instead of TIMIFY's internal MongoDB ID.

Example: external=true
Headers
company-idstring

Company MongoDB id used in auth context.

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

Responses

Confirms deletion of the enterprise group service and returns the deleted service 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": "65f4c840b6f1a10012ab34cd",
    "externalId": "ext-course-001",
    "name": "Advanced Yoga Workshop",
    "price": 299.99,
    "maxParticipants": 20,
    "deletedAt": "2024-03-07T14:22:15Z",
    "ts": 1709823735
  },
  "status": 1
}

Fetch enterprise group service

Request

The URL parameter "groupServiceId" can be used in two ways: - use the unique ID of the service assigned by TIMIFY ("groupServiceId"). In this case, you don't need the QUERY parameter "external" - use the "externalId" that you added to this service. In this case, you need to add the parameter "external" ( for ex.: /?external=1) so the Developer API will search by your "externalId" and not by "serviceId" assigned by TIMIFY You can add "externalId" to the service with the Developer API endpoints POST /services and PATCH /services/:groupServiceId

Security
BearerAuth
Path
groupServiceIdstringrequired

Groupserviceid path parameter.

Example: 65f4c840b6f1a10012ab34cd
Query
externalboolean

When set to 1, the path ID parameter is treated as an externalId instead of TIMIFY's internal MongoDB ID.

Example: external=true
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/65f4c840b6f1a10012ab34cd?external=true&with_full_attributes=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns the specified enterprise group service with complete details including pricing, capacity, and scheduling information.

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,
    "currentParticipants": 12,
    "isBookable": true,
    "isCourse": true,
    "categoryId": "65f5d950c7g2b20123bc45de",
    "categoryName": "Wellness & Fitness",
    "resourceIds": [ … ],
    "scheduleType": "RECURRING",
    "frequency": "WEEKLY",
    "upcomingSessions": 8,
    "totalCompletedParticipants": 45,
    "color": "#00AA00",
    "orderIndex": 1,
    "createdAt": "2024-03-01T10:30:00Z",
    "updatedAt": "2024-03-07T14:22:15Z",
    "ts": 1709823735
  },
  "status": 1
}

Update enterprise group service

Request

The URL parameter "groupServiceId" can be used in two ways: - use the unique ID of the group service assigned by TIMIFY ("groupServiceId"). In this case, you don't need the QUERY parameter "external" - use the "externalId" that you added to this service. In this case, you need to add the parameter "external" ( for ex.: /?external=1) so the Developer API will search by your "externalId" and not by "groupServiceId" assigned by TIMIFY You can add "externalId" to the group service with the Developer API

Security
BearerAuth
Path
groupServiceIdstringrequired

Groupserviceid path parameter.

Example: 65f4c840b6f1a10012ab34cd
Query
externalboolean

When set to 1, the path ID parameter is treated as an externalId instead of TIMIFY's internal MongoDB ID.

Example: external=true
Headers
company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd
Bodyapplication/jsonrequired
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
affected_branch_idsArray of stringsnon-empty

Affected branch ids.

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

Affected branch external ids.

Example: ["65f4c840b6f1a10012ab34cd"]
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>= 0

Duration.

Example: 20
duration_beforeinteger>= 0

Duration before.

Example: 20
duration_afterinteger>= 0

Duration after.

Example: 20
durations_patternArray of integersnon-empty

Durations pattern.

Example: [15]
pricenumber>= 0

Price.

Example: 19.9
max_participantsinteger>= 0

Max participants.

Example: 20
dependenciesstring

Dependencies.

Example: "example"
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"
locationobject

Location.

Example: {"key":"value"}
curl -i -X PATCH \
  'https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-group-services/65f4c840b6f1a10012ab34cd?external=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd' \
  -d '{
    "has_online_payment": true,
    "is_bookable": true,
    "is_stalled": true,
    "is_payment_mandatory": true,
    "affected_branch_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "affected_branch_external_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "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,
    "max_participants": 20,
    "dependencies": "example",
    "maximum_lead_time": "09:30",
    "minimum_lead_time": "09:30",
    "cancellation_lead_time": "09:30",
    "attributes": "example",
    "location": {
      "key": "value"
    }
  }'

Responses

Updates the enterprise group service and returns the updated service 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": "65f4c840b6f1a10012ab34cd",
    "externalId": "ext-course-001",
    "name": "Advanced Yoga Workshop - Spring 2024",
    "description": "10-week intensive yoga program for intermediate practitioners",
    "duration": 75,
    "durationBefore": 10,
    "durationAfter": 5,
    "price": 349.99,
    "currency": "USD",
    "maxParticipants": 25,
    "minParticipants": 5,
    "isBookable": true,
    "isCourse": true,
    "categoryId": "65f5d950c7g2b20123bc45de",
    "resourceIds": [ … ],
    "scheduleType": "RECURRING",
    "frequency": "WEEKLY",
    "color": "#00AA00",
    "updatedAt": "2024-03-07T14:22:15Z",
    "ts": 1709823735
  },
  "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