How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenProject Principals API

Principals are the superclass of users, groups and placeholder users. This endpoint returns all principalswithin a joined collection but can be filtered to e.g. only return groups or users.

OpenProject Principals API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Principals. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.1.2, at version 3.

Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.

11 operations 5 paths 15 schemas 2 DELETE5 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3
Base URL
https://community.openproject.org/api/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

OpenProject Principals API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Principals 11

Principals are the superclass of users, groups and placeholder users. This endpoint returns all principals within a joined collection but can be filtered to e.g. only return group…

GET
/api/v3/placeholder_users
List placehoder users
list_placeholder_users 2 params → 200400
POST
/api/v3/placeholder_users
Create placeholder user
create_placeholder_user body → 201400403406415422
DELETE
/api/v3/placeholder_users/{id}
Delete placeholder user
delete_placeholder_user 1 param → 202403404
GET
/api/v3/placeholder_users/{id}
View placeholder user
view_placeholder_user 1 param → 200404
PATCH
/api/v3/placeholder_users/{id}
Update placeholder user
update_placeholder_user 1 param body → 200400403404406415422
GET
/api/v3/principals
List principals
list_principals 2 params → 200400
GET
/api/v3/users
List Users
list_Users 5 params → 200400403
POST
/api/v3/users
Create User
create_user body → 201400403406415422
DELETE
/api/v3/users/{id}
Delete user
delete_user 1 param → 202403404
GET
/api/v3/users/{id}
View user
view_user 1 param → 200404
PATCH
/api/v3/users/{id}
Update user
update_user 1 param body → 200400403404406415422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are UserCreateModel (9 properties), Link (7 properties), PrincipalModel (6 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.

CollectionModel
object
4 properties 4 required
Link
object
7 properties 1 required
GroupModel
PrincipalModel
object
6 properties 4 required
CollectionLinks
object
1 property 1 required
UserCreateModel
object
9 properties 6 required
UserCollectionModel
PlaceholderUserModel
OffsetPaginatedCollectionModel
ErrorResponse
object
4 properties 3 required
UserModel
PrincipalCollectionModel
PlaceholderUserCreateModel
object
1 property
OffsetPaginatedCollectionLinks
CustomFieldProperties
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openproject-principals-api-openapi.yml Raw ↑

Other APIs OpenProject publishes across the network.

OpenProject Actions & Capabilities API
OpenProject Activities API
OpenProject Attachments API
OpenProject Budgets API
OpenProject Categories API
OpenProject Collections API
OpenProject Configuration API
OpenProject Custom actions API
OpenProject Custom Field Items API
OpenProject Custom Fields API
OpenProject Custom Options API
OpenProject Documents API
Where this information came from

This is an independent, third-party profile of OpenProject Principals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.