Post import

TIMIFY Developer API GraphQL Proxy (0.0.4)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

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

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

Update enterprise custom field

Request

Each custom field is a data field for every customer. For example: firstName, lastName etc. With this endpoint, you can create your own custom fields like customerNr.

Security

BearerAuth

Path

fieldIdstringrequired

Fieldid 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

is_mandatory_onlineboolean

Is mandatory online.

Example: true

is_mandatory_offlineboolean

Is mandatory offline.

Example: true

labelstringrequired

Label.

Example: "example"

typestringrequired

Type.

Example: "active"

optionsstringrequired

Options.

Example: "example"

activestring

Active.

Example: "example"

publishedstring

Published.

Example: "example"

is_unique_keyboolean

Is unique key.

Example: true

descriptionstring

Description.

Example: "example"

specific_service_category_idsArray of stringsnon-empty

Specific service category ids.

Example: ["65f4c840b6f1a10012ab34cd"]

specific_course_category_idsArray of stringsnon-empty

Specific course category ids.

Example: ["65f4c840b6f1a10012ab34cd"]

service_idsArray of stringsnon-emptyrequired

Service ids.

Example: ["65f4c840b6f1a10012ab34cd"]

course_idsArray of stringsnon-emptyrequired

Course ids.

Example: ["65f4c840b6f1a10012ab34cd"]

category_idstringrequired

Category id.

Example: "65f4c840b6f1a10012ab34cd"

has_overwriteboolean

Has overwrite.

Example: true

pricenumber>= 0

Price.

Example: 19.9

durationinteger>= 0

Duration.

Example: 20

external_idstring

External id.

Example: "65f4c840b6f1a10012ab34cd"

order_indexstring

Order index.

Example: "example"

curl -i -X PATCH \
  'https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-customers/customfields/65f4c840b6f1a10012ab34cd?external=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd' \
  -d '{
    "is_mandatory_online": true,
    "is_mandatory_offline": true,
    "label": "example",
    "type": "active",
    "options": "example",
    "active": "example",
    "published": "example",
    "is_unique_key": true,
    "description": "example",
    "specific_service_category_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "specific_course_category_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "service_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "course_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "category_id": "65f4c840b6f1a10012ab34cd",
    "has_overwrite": true,
    "price": 19.9,
    "duration": 20,
    "external_id": "65f4c840b6f1a10012ab34cd",
    "order_index": "example"
  }'

Responses

Updates the enterprise custom field definition and returns the updated field 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_1001",
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "email": "john@example.com",
    "phone": { … },
    "tags": [ … ],
    "totalBookings": 5,
    "avatarUrl": "https://example.com/avatar.jpg",
    "firstLetters": "JD",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-02-20T14:45:30Z",
    "ts": 1708430730
  },
  "status": 1
}

Post import

Request

Bulk import or update enterprise customers.

Security

BearerAuth

Headers

company-idstring

Company MongoDB id used in auth context.

Example: 65f4c840b6f1a10012ab34cd

Bodyapplication/json

customersstring

Customers.

Example: "example"

urlstring(uri)

Url.

Example: "https://example.com"

secretstring

Secret.

Example: "example"

chunk_sizestring

Chunk size.

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"]

curl -i -X POST \
  https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-customers/import \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd' \
  -d '{
    "customers": "example",
    "url": "https://example.com",
    "secret": "example",
    "chunk_size": "example",
    "affected_branch_ids": [
      "65f4c840b6f1a10012ab34cd"
    ],
    "affected_branch_external_ids": [
      "65f4c840b6f1a10012ab34cd"
    ]
  }'

Responses

Bulk imports or updates enterprise customers and returns import result with success/error status for each 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_1001",
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "email": "john@example.com",
    "phone": { … },
    "tags": [ … ],
    "totalBookings": 5,
    "avatarUrl": "https://example.com/avatar.jpg",
    "firstLetters": "JD",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-02-20T14:45:30Z",
    "ts": 1708430730
  },
  "status": 1
}

Delete enterprise customer

Request

Delete a customer with the "customerId" or "externalId" parameter

Security

BearerAuth

Path

customerIdstringrequired

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

Responses

Confirms deletion of the enterprise customer and returns the deleted customer 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_1001",
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "email": "john@example.com",
    "phone": { … },
    "tags": [ … ],
    "totalBookings": 5,
    "avatarUrl": "https://example.com/avatar.jpg",
    "firstLetters": "JD",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-02-20T14:45:30Z",
    "ts": 1708430730
  },
  "status": 1
}

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

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

Update enterprise custom field

Request

Responses

Was this helpful?

Post import

Request

Responses

Was this helpful?

Delete enterprise customer

Request

Responses

Was this helpful?

Companies

Enterprises

Permissions

Services

Enterprise Services

Group Services

Enterprise Group Services

Resources

Enterprise Resource Categories

Notifications

Files

ICS

Tags

Statistics

Transactions

Public