---
updatedAt: 2025-06-05T21:40:43.000Z
agentTools:
  projectIndex: https://apidocs.officient.io/llms.txt
---

# Custom event types

fetch a list of custom event types including time off types, overtime types,..

Scope required: calendar:read

A type alias can be changed by the Officient user and is how they will recognise the type.\
The color field indicates the hex color used in Officient for this type (eg FF0000 for red)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "officient-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.officient.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/1.0/calendar/events/types/{year}": {
      "get": {
        "summary": "Custom event types",
        "description": "fetch a list of custom event types including time off types, overtime types,..",
        "operationId": "event-types",
        "parameters": [
          {
            "name": "year",
            "in": "path",
            "description": "the year you want custom event type to be returned for",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"id\": 1350,\n            \"name\": \"Holidays\",\n            \"alias\": \"Holidays\",\n            \"active\": 1,\n            \"color\": \"a24689\",\n            \"interpretation\": \"time_off\",\n            \"integrations\": [\n                {\n                    \"app\": \"sdworx\",\n                    \"code\": \"122\"\n                }\n            ]\n        },\n        {\n            \"id\": 1434,\n            \"name\": \"Paid holiday\",\n            \"alias\": \"Paid holiday\",\n            \"active\": 1,\n            \"color\": \"7986c9\",\n            \"interpretation\": \"time_off\",\n            \"integrations\": [\n                {\n                    \"app\": \"acerta\",\n                    \"code\": \"192\"\n                }\n            ]\n        },\n        {\n            \"id\": 1390,\n            \"name\": \"Overtime\",\n            \"alias\": \"Overtime\",\n            \"active\": 0,\n            \"color\": \"35b579\",\n            \"interpretation\": \"overtime\",\n            \"integrations\": [\n                {\n                    \"app\": \"liantis\",\n                    \"code\": \"100\"\n                }\n            ]\n        }\n      ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 1350,
                            "default": 0
                          },
                          "name": {
                            "type": "string",
                            "example": "Holidays"
                          },
                          "alias": {
                            "type": "string",
                            "example": "Holidays"
                          },
                          "active": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "color": {
                            "type": "string",
                            "example": "a24689"
                          },
                          "interpretation": {
                            "type": "string",
                            "example": "time_off"
                          },
                          "integrations": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "app": {
                                  "type": "string",
                                  "example": "sdworx"
                                },
                                "code": {
                                  "type": "string",
                                  "example": "122"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```