# Apiable Platform API

**Canonical:** https://apis.io/apis/apiable/platform-api/  
**Provider:** Apiable — https://apis.io/providers/apiable/  
**Base URL:** https://developer.apiable.io  
**Documentation:** https://www.apiable.io/docs/api-reference/

Apiable Platform API is one of 2 APIs that [Apiable](https://apis.io/providers/apiable/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include API Portal, API Products, Subscriptions, Webhooks, and Monetization. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

The Apiable Platform API (v2) is the REST API Apiable publishes for managing an API program programmatically: products, plans, subscriptions, teams, users, companies, invitations, documentation entries, file uploads and outbound webhooks. It is an OpenAPI 3.1 contract of 66 operations across 12 resource groups, authenticated with OAuth 2.0 client credentials and scoped with apiable/platform and apiable/cicd. Each customer calls it on their own portal host; the published contract names Apiable's own reference portal in servers[].

## Operations (60 of 66)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/webhooks/{id}` | Retrieve a webhook by ID |
| PUT | `/api/webhooks/{id}` | Update webhook |
| DELETE | `/api/webhooks/{id}` | Unregister a webhook |
| PUT | `/api/users/{id}/roles` | Update User Roles |
| PUT | `/api/teams/{teamId}/users/{userId}` | Assign user into a team |
| DELETE | `/api/teams/{teamId}/users/{userId}` | Remove user from team |
| PUT | `/api/subscriptions/{id}/custom-properties` | Read/Write subscription custom properties |
| GET | `/api/webhooks` | Retrieve Registered Webhooks |
| POST | `/api/webhooks` | Register a webhook |
| POST | `/api/users/{id}/reject` | Reject User |
| POST | `/api/users/{id}/approve` | Approve User |
| GET | `/api/teams` | Read Teams |
| POST | `/api/teams` | Create a new team |
| GET | `/api/subscriptions` | Retrieve all subscriptions |
| POST | `/api/subscriptions` | Create a new subscription |
| POST | `/api/subscriptions/{id}/reject` | Reject a subscription |
| POST | `/api/subscriptions/{id}/refresh-billing` | Refresh subscription billing status |
| POST | `/api/subscriptions/{id}/approve` | Approve a subscription |
| POST | `/api/subscriptions/usage` | Meter usage for subscription billing |
| GET | `/api/plans/{id}/docs` | Get the plan-level docs of the plan specified by the plan id |
| POST | `/api/plans/{id}/docs` | Create the plan-level doc to the plan |
| GET | `/api/plans/{id}/apis/{integrationId}/docs` | Get the api-level docs of all apis specified by the API integrationId in the plan |
| POST | `/api/plans/{id}/apis/{integrationId}/docs` | Create the api-level doc to all apis specified by the API integrationId in the plan |
| GET | `/api/plans/apis/{integrationId}/docs` | Get the api-level docs of all apis specified by the API integrationId of all plans |
| POST | `/api/plans/apis/{integrationId}/docs` | Create the api-level doc to all apis specified by the API integrationId |
| GET | `/api/invitations` | Read Invitations |
| POST | `/api/invitations` | Create Invitation |
| POST | `/api/files/upload` | Upload a file |
| GET | `/api/users/{id}` | Read User |
| PATCH | `/api/users/{id}` | Update User |
| GET | `/api/teams/{id}` | Read Team |
| PATCH | `/api/teams/{id}` | Update Team |
| GET | `/api/subscriptions/{subscriptionId}/custom-properties/{customPropertyId}` | Get a specific custom property by id for the subscription |
| PATCH | `/api/subscriptions/{subscriptionId}/custom-properties/{customPropertyId}` | Update a specific custom property by id for the subscription |
| GET | `/api/subscriptions/{id}` | Get subscription by ID |
| DELETE | `/api/subscriptions/{id}` | Cancel and revoke a subscription |
| PATCH | `/api/subscriptions/{id}` | Update a subscription |
| PATCH | `/api/subscriptions/custom-properties/{customPropertyId}` | Update a specific custom property by id for all subscriptions |
| GET | `/api/plans/{id}/docs/{docId}` | Get the plan-level doc of the plan specified by the plan id |
| DELETE | `/api/plans/{id}/docs/{docId}` | Delete a plan level documentation from a plan |
| PATCH | `/api/plans/{id}/docs/{docId}` | Patch the plan-level doc |
| GET | `/api/plans/{id}/apis/{integrationId}/docs/{docId}` | Get the api-level doc of all apis specified by the API integrationId |
| DELETE | `/api/plans/{id}/apis/{integrationId}/docs/{docId}` | Delete an API level documentation from a plan |
| PATCH | `/api/plans/{id}/apis/{integrationId}/docs/{docId}` | Patch the api-level doc |
| GET | `/api/plans/apis/{integrationId}/docs/{docId}` | Get the api-level doc of all apis specified by the API integrationId |
| DELETE | `/api/plans/apis/{integrationId}/docs/{docId}` | Delete an api level documentation from a plan |
| PATCH | `/api/plans/apis/{integrationId}/docs/{docId}` | Patch the api-level doc |
| GET | `/api/invitations/{id}` | Read Invitation |
| PATCH | `/api/invitations/{id}` | Update an invitation |
| GET | `/api/docs/{docId}` | Get the doc by id |
| PATCH | `/api/docs/{docId}` | Patch the doc by id |
| PATCH | `/api/docs/full-api-doc` | Update the Full API reference |
| GET | `/api/companies/{id}` | Get company by ID |
| PATCH | `/api/companies/{id}` | Update a company |
| GET | `/api/webhooks/{id}/test` | Test a webhook by ID |
| GET | `/api/webhooks/{id}/history` | Retrieve the history of webhook results for the past 24 hours |
| GET | `/api/versions` | Get versions of the API |
| GET | `/api/users` | Read Users |
| GET | `/api/subscriptions/{subscriptionId}/custom-properties` | Get the custom properties for the subscription |
| GET | `/api/products` | Read Products |

…and 6 more operations. They are listed in full on the page.

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/openapi/apiable-platform-api-openapi.json
- **APIReference** — https://www.apiable.io/docs/api-reference/
- **Documentation** — https://www.apiable.io/docs/automation/
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/authentication/apiable-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/scopes/apiable-scopes.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/asyncapi/apiable-webhooks.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/errors/apiable-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/conventions/apiable-conventions.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/data-model/apiable-data-model.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/overlays/apiable-platform-api-overlay.yaml
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/skills/_index.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/apiable/refs/heads/main/apis.yml

## Other Apiable APIs (1)

- [Apiable API Portal Platform](https://apis.io/apis/apiable/api-portal-platform/)

## Tags

API Portal, API Products, Subscriptions, Webhooks, Monetization, Platform API

---

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