Skip to content
/
Create enterprise custom...

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

List enterprise custom fields

Request

List custom field definitions for enterprise customers.

Security
BearerAuth
Query
idsArray of stringsnon-empty

Filter or option: ids.

Example: ids=65f4c840b6f1a10012ab34cd
external_idsArray of stringsnon-empty

Filter or option: external ids.

Example: external_ids=65f4c840b6f1a10012ab34cd
is_mandatory_onlineboolean

Filter or option: is mandatory online.

Example: is_mandatory_online=true
is_mandatory_offlineboolean

Filter or option: is mandatory offline.

Example: is_mandatory_offline=true
is_defaultboolean

Filter or option: is default.

Example: is_default=true
typestring

Filter or option: type.

Example: type=active
is_publishedboolean

Filter or option: is published.

Example: is_published=true
category_idstring

Filter or option: category id.

Example: category_id=65f4c840b6f1a10012ab34cd
has_overwriteboolean

Filter or option: has overwrite.

Example: has_overwrite=true
is_activeboolean

Filter or option: is active.

Example: is_active=true
services_idsArray of stringsnon-empty

Filter or option: services ids.

Example: services_ids=65f4c840b6f1a10012ab34cd
courses_idsArray of stringsnon-empty

Filter or option: courses ids.

Example: courses_ids=65f4c840b6f1a10012ab34cd
internal_idstring

Filter or option: internal id.

Example: internal_id=65f4c840b6f1a10012ab34cd
only_localsstring

Filter or option: only locals.

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-customers/customfields?ids=65f4c840b6f1a10012ab34cd&external_ids=65f4c840b6f1a10012ab34cd&is_mandatory_online=true&is_mandatory_offline=true&is_default=true&type=active&is_published=true&category_id=65f4c840b6f1a10012ab34cd&has_overwrite=true&is_active=true&services_ids=65f4c840b6f1a10012ab34cd&courses_ids=65f4c840b6f1a10012ab34cd&internal_id=65f4c840b6f1a10012ab34cd&only_locals=string&page=1&limit=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns paginated list of custom field definitions for enterprise customers.

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

Create enterprise custom field

Request

All new custom fields are available to all customers.

Security
BearerAuth
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
external_idstring

External id.

Example: "65f4c840b6f1a10012ab34cd"
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
order_indexstring

Order index.

Example: "example"
curl -i -X POST \
  https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-customers/customfields \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd' \
  -d '{
    "is_mandatory_online": true,
    "is_mandatory_offline": true,
    "external_id": "65f4c840b6f1a10012ab34cd",
    "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,
    "order_index": "example"
  }'

Responses

Creates new enterprise custom field definition and returns created field 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_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
}

List enterprise custom field categories

Request

List categories that group enterprise customer custom fields.

Security
BearerAuth
Query
idsArray of stringsnon-empty

Filter or option: ids.

Example: ids=65f4c840b6f1a10012ab34cd
is_defaultboolean

Filter or option: is default.

Example: is_default=true
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-customers/customfields/categories?ids=65f4c840b6f1a10012ab34cd&is_default=true&page=1&limit=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns paginated list of enterprise custom field categories that group custom field definitions.

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
{
  "total": 182,
  "data": [
    { … },
    { … }
  ],
  "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

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