Get Service

Retrieve a service or list services from the calendar system.

List Services

GET /v2/services

Headers

Name	Required	Description
x-api-key	Yes	Your API key
x-api-secret	Yes	Your API secret

Query Parameters

Parameter	Type	Required	Description
page	number	No	Page number (default: 1)
limit	number	No	Items per page (default: 10)
search	string	No	Search term to filter services by name
sortBy	string	No	Field to sort by (name, createdAt, updatedAt)
sortOrder	string	No	Sort order (asc, desc)

Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Professional Consultation",
      "description": "A comprehensive consultation service",
      "imageUrl": "https://example.com/service-image.png",
      "dateRanges": [
        {
          "start": "2025-05-22T10:30:00Z",
          "end": "2025-05-22T18:30:00Z"
        }
      ],
      "bookingOptions": {
        "duration": 60,
        "bufferTime": 15,
        "maxParticipants": 1,
        "autoAccept": true
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1
  }
}

Get Single Service

GET /v2/services/:id

Headers

Name	Required	Description
x-api-key	Yes	Your API key
x-api-secret	Yes	Your API secret

URL Parameters

Parameter	Type	Description
id	string	The ID of the service to fetch

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Professional Consultation",
  "description": "A comprehensive consultation service",
  "imageUrl": "https://example.com/service-image.png",
  "dateRanges": [
    {
      "start": "2025-05-22T10:30:00Z",
      "end": "2025-05-22T18:30:00Z"
    }
  ],
  "bookingOptions": {
    "duration": 60,
    "bufferTime": 15,
    "maxParticipants": 1,
    "autoAccept": true
  }
}

Error Responses

Status	Description
401	Unauthorized - Invalid API key or secret
403	Forbidden - Insufficient permissions
404	Not Found - Service does not exist