Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Members API

The Members API from Qovery — 4 operation(s) for members.

Qovery Members API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Members. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 9 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

9 operations 4 paths 10 schemas 2 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Members API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Members 9
GET
/organization/{organizationId}/member
Get organization members
getOrganizationMembers 1 param → 200401403404
PUT
/organization/{organizationId}/member
Edit an organization member role
editOrganizationMemberRole 1 param body → 200400401403404
DELETE
/organization/{organizationId}/member
Remove a member
deleteMember 1 param body → 204401403404
GET
/organization/{organizationId}/inviteMember
Get invited members
getOrganizationInvitedMembers 1 param → 200401403404
POST
/organization/{organizationId}/inviteMember
Invite someone in the organization
postInviteMember 1 param body → 201400401403404409
GET
/organization/{organizationId}/inviteMember/{inviteId}
Get member invitation
getMemberInvitation 2 params → 200401403404
POST
/organization/{organizationId}/inviteMember/{inviteId}
Accept Invite in the organization
postAcceptInviteMember 2 params → 201400401403404409
DELETE
/organization/{organizationId}/inviteMember/{inviteId}
Remove an invited member
deleteInviteMember 2 params → 204401403404
POST
/organization/{organizationId}/transferOwnership
Transfer organization ownership to another user
postOrganizationTransferOwnership 1 param body → 204400401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are InviteMemberRequest (3 properties), Base (3 properties), MemberRoleUpdateRequest (2 properties), MemberResponseList (1 property). Each schema is shown below with its type and property counts.

InviteMemberResponseList
object
1 property
MemberRoleUpdateRequest
object
2 properties 2 required
InviteStatusEnum
string
InviteMemberRequest
object
3 properties 1 required
TransferOwnershipRequest
object
1 property 1 required
InviteMemberRoleEnum
string
deprecated
Member
MemberResponseList
object
1 property
Base
object
3 properties 2 required
InviteMember

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-members-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API