> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/announcements.md).

# Announcements

## GET /api/v1/employee/announcements/{employeeId}

> Lists all the announcement headers visible by an employee matching some search params

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"PaginableGenericListResultAnnouncementHeaderForEmployeeDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"}}}},"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}},"paths":{"/api/v1/employee/announcements/{employeeId}":{"get":{"tags":["Announcements"],"description":"Lists all the announcement headers visible by an employee matching some search params","operationId":"searchAnnouncementHeaders","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"to","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"text","in":"query","required":false,"schema":{"type":"string"}},{"name":"sectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"categoryId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginableGenericListResultAnnouncementHeaderForEmployeeDTO"}}}}}}}}}
```

## POST /api/v1/employee/announcements/{employeeId}

> Creates a very simple announcement

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"AnnouncementForEmployeeDTO":{"allOf":[{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"message":{"type":"string","description":"Full announcement message body (HTML or plain text)"}}}],"description":"Full announcement for employee view: header fields plus message body."},"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}},"paths":{"/api/v1/employee/announcements/{employeeId}":{"post":{"tags":["Announcements"],"description":"Creates a very simple announcement","operationId":"employeePostAnnouncement","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementForEmployeeDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementForEmployeeDTO"}}}}}}}}}
```

## GET /api/v1/employee/announcements/{employeeId}/status

> Get's announcements status (unread, expiring soon, etc.) for that employee

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"AnnouncementStatusDTO":{"type":"object","description":"Announcement status for the employee: count of unread announcements.","properties":{"unread":{"type":"integer","format":"int32","description":"Number of unread announcements"}}}}},"paths":{"/api/v1/employee/announcements/{employeeId}/status":{"get":{"tags":["Announcements"],"description":"Get's announcements status (unread, expiring soon, etc.) for that employee","operationId":"getAnnouncementsStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementStatusDTO"}}}}}}}}}
```

## GET /api/v1/employee/announcements/{employeeId}/read/{id}

> Get's only one announcement

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"AnnouncementForEmployeeDTO":{"allOf":[{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"message":{"type":"string","description":"Full announcement message body (HTML or plain text)"}}}],"description":"Full announcement for employee view: header fields plus message body."},"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}},"paths":{"/api/v1/employee/announcements/{employeeId}/read/{id}":{"get":{"tags":["Announcements"],"description":"Get's only one announcement","operationId":"getAnnouncementById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementForEmployeeDTO"}}}}}}}}}
```

## GET /api/v1/employee/announcements/{employeeId}/pending

> Lists the visible on login announcements of an employee. A maximum of 6 is returned

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"AnnouncementForEmployeeDTO":{"allOf":[{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"message":{"type":"string","description":"Full announcement message body (HTML or plain text)"}}}],"description":"Full announcement for employee view: header fields plus message body."},"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}},"paths":{"/api/v1/employee/announcements/{employeeId}/pending":{"get":{"tags":["Announcements"],"description":"Lists the visible on login announcements of an employee. A maximum of 6 is returned","operationId":"getPendingOnLoginAnnouncements","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementForEmployeeDTO"}}}}}}}}}}
```

## GET /api/v1/employee/announcements/{employeeId}/header/{id}

> Get's only one announcement header

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}},"paths":{"/api/v1/employee/announcements/{employeeId}/header/{id}":{"get":{"tags":["Announcements"],"description":"Get's only one announcement header","operationId":"getEmployeeAnnouncementHeaderById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"}}}}}}}}}
```

## GET /api/v1/employee/announcements/{employeeId}/categories

> &#x20;Get's the list of announcement categories

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}}}},"paths":{"/api/v1/employee/announcements/{employeeId}/categories":{"get":{"tags":["Announcements"],"description":" Get's the list of announcement categories","operationId":"getEmployeeAnnouncementCategories","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}}}}}}}}}}
```
