# OpenProject Help texts API

**Canonical:** https://apis.io/apis/openproject/openproject-help-texts-api/  
**Provider:** OpenProject — https://apis.io/providers/openproject/  
**Base URL:** https://community.openproject.org/api/v3  
**Documentation:** https://www.openproject.org/docs/api/

OpenProject Help texts API is one of 62 APIs that [OpenProject](https://apis.io/providers/openproject/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Help texts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The help texts endpoints return collections or single entities of type `HelpText`. The following tables list the different properties of `HelpText` entities. ## Linked Properties | Link | Description | Type | Constraints | Supported operations | |:-------------:|-------------------------- | ------------- | ----------- | -------------------- | | self | This help text | HelpText | not null | READ | | editText | Edit the help text entry | text/htm | Admin | READ | ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------: | --------------------------- | -------------------- | ----------- | -------------------- | | id | Help text id | Integer | x > 0 | READ | | attribute | Attribute name | String | | READ | | attributeCaption | Attribute caption | String | | READ | | helpText | Help text content | Formattable | | READ |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-help-texts-api-openapi.yml
- **Documentation** — https://www.openproject.org/docs/api/
- **Introduction** — https://www.openproject.org/docs/api/introduction/
- **Endpoints** — https://www.openproject.org/docs/api/endpoints/
- **GitHub** — https://github.com/opf/openproject

## Other OpenProject APIs (12)

- [OpenProject Actions & Capabilities API](https://apis.io/apis/openproject/openproject-actions-capabilities-api/)
- [OpenProject Activities API](https://apis.io/apis/openproject/openproject-activities-api/)
- [OpenProject Attachments API](https://apis.io/apis/openproject/openproject-attachments-api/)
- [OpenProject Budgets API](https://apis.io/apis/openproject/openproject-budgets-api/)
- [OpenProject Categories API](https://apis.io/apis/openproject/openproject-categories-api/)
- [OpenProject Collections API](https://apis.io/apis/openproject/openproject-collections-api/)
- [OpenProject Configuration API](https://apis.io/apis/openproject/openproject-configuration-api/)
- [OpenProject Custom actions API](https://apis.io/apis/openproject/openproject-custom-actions-api/)
- [OpenProject Custom Field Items API](https://apis.io/apis/openproject/openproject-custom-field-items-api/)
- [OpenProject Custom Fields API](https://apis.io/apis/openproject/openproject-custom-fields-api/)
- [OpenProject Custom Options API](https://apis.io/apis/openproject/openproject-custom-options-api/)
- [OpenProject Documents API](https://apis.io/apis/openproject/openproject-documents-api/)

## Tags

Help texts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openproject/openproject-help-texts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openproject/.