Skip to content
/
Update enterprise custome...

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

Fetch enterprise customer

Request

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

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 GET \
  'https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-customers/65f4c840b6f1a10012ab34cd?external=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns the specified enterprise customer record with complete profile 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",
    "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
}

Update enterprise customer

Request

Update the data of a customer. Customer data is created and updated with the "customfield" attribute. Every data attribute of a customer is a custom field, for example firstName, lastName, email etc. The URL parameter "customerId" can be used in two ways: - As a unique ID of the customer assigned by TIMIFY ("customerId"). In this case, you don't need the QUERY parameter "external" - use the "externalId" that you added to this customer. In this case, you need to add the parameter "external" ( for ex.: /?external=1) the API will search by your "externalId" and not by "customerId" assigned by TIMIFY You can add "externalId" to the customer with the Developer API endpoints POST /customers and PATCH /customers/:customerId You can use the endpoint GET /customers/customfields to retrieve all available custom fields for the selected company. To create a new custom field you can use the endpoint POST /customers/customfields

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
Bodyapplication/json
customfieldsArray of objects(CustomFieldValue)

Custom field values for the appointment. Each item is a {id, value} pair.

Example: [{"id":"62ee11aa1d66269c365407c2","value":"John"}]
external_idstring

External id.

Example: "65f4c840b6f1a10012ab34cd"
ignore_mandatory_validationstring

Ignore mandatory validation.

Example: "example"
import_customer_idstring

Import customer id.

Example: "65f4c840b6f1a10012ab34cd"
curl -i -X PATCH \
  'https://docs2.timify.com/_mock/apis/openapi/v1/enterprise-customers/65f4c840b6f1a10012ab34cd?external=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd' \
  -d '{
    "customfields": [
      {
        "id": "62ee11aa1d66269c365407c2",
        "value": "John"
      }
    ],
    "external_id": "65f4c840b6f1a10012ab34cd",
    "ignore_mandatory_validation": "example",
    "import_customer_id": "65f4c840b6f1a10012ab34cd"
  }'

Responses

Updates the enterprise customer record and returns the updated customer with all profile 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",
    "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 customer events

Request

List customer events

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
customer_filter_typestring

Filter or option: customer filter type.

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
with_full_attributesboolean

Filter or option: with full attributes.

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-customers/65f4c840b6f1a10012ab34cd/events?external=true&customer_filter_type=string&page=1&limit=50&with_full_attributes=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'company-id: 65f4c840b6f1a10012ab34cd'

Responses

Returns paginated list of events for the specified enterprise customer.

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