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

Apiman Organizations API

The Organizations API from Apiman — 57 operation(s) for organizations.

Apiman Organizations API is one of 16 APIs that Apiman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 88 operations across 57 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 3.1.0-SNAPSHOT.

Requests are made against a single base URL, /apiman.

88 operations 57 paths 67 schemas 13 DELETE46 GET17 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.1.0-SNAPSHOT
Base URL
https://{apiman_host}/apiman
Resource Areas
1

Paths & Operations 88

Across 57 paths, the API surfaces 88 operations — 13 DELETE, 46 GET, 17 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 88
GET
/organizations/{organizationId}/apis
List APIs
listApis 1 param → 200404
POST
/organizations/{organizationId}/apis
Create API
createApi 1 param body → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/policies
List All API Policies
listApiPolicies_1 3 params → 200404
POST
/organizations/{organizationId}/apis/{apiId}/versions/{version}/policies
Add API Policy
createApiPolicy 3 params body → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions
List API Versions
listApiVersions_1 2 params → 200
POST
/organizations/{organizationId}/apis/{apiId}/versions
Create API Version
createApiVersion 2 params body → 200404409
GET
/organizations/{organizationId}/clients
List Clients
listClients 1 param → 200404
POST
/organizations/{organizationId}/clients
Create Client
createClient 1 param body → 200404
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/policies
List All Client Policies
listClientPolicies 3 params → 200404
POST
/organizations/{organizationId}/clients/{clientId}/versions/{version}/policies
Add Client Policy
createClientPolicy 3 params body → 200404
GET
/organizations/{organizationId}/clients/{clientId}/versions
List Client Versions
listClientVersions 2 params → 200
POST
/organizations/{organizationId}/clients/{clientId}/versions
Create Client Version
createClientVersion 2 params body → 200404409
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts
List All Contracts for a Client
getClientVersionContracts 3 params → 200404
POST
/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts
Create an API Contract
createContract 3 params body → 200404
DELETE
/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts
Break All Contracts
deleteAllContracts 3 params → 200404
POST
/organizations
Create Organization
createOrg body → 200
GET
/organizations/{organizationId}/plans
List Plans
listPlans 1 param → 200404
POST
/organizations/{organizationId}/plans
Create Plan
createPlan 1 param body → 200404
GET
/organizations/{organizationId}/plans/{planId}/versions/{version}/policies
List All Plan Policies
listPlanPolicies_1 3 params → 200404
POST
/organizations/{organizationId}/plans/{planId}/versions/{version}/policies
Add Plan Policy
createPlanPolicy 3 params body → 200404
GET
/organizations/{organizationId}/plans/{planId}/versions
List Plan Versions
listPlanVersions 2 params → 200
POST
/organizations/{organizationId}/plans/{planId}/versions
Create Plan Version
createPlanVersion 2 params body → 200404409
GET
/organizations/{organizationId}/apis/{apiId}
Get API By ID
getApi 2 params → 200404
PUT
/organizations/{organizationId}/apis/{apiId}
Update API
updateApi 2 params body → 204404
DELETE
/organizations/{organizationId}/apis/{apiId}
Delete API
deleteApi 2 params → 204404409
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/definition
Get API Definition
getApiDefinition_2 3 params → 200404
PUT
/organizations/{organizationId}/apis/{apiId}/versions/{version}/definition
Update API Definition
updateApiDefinition 3 params → 204404
POST
/organizations/{organizationId}/apis/{apiId}/versions/{version}/definition
Update API Definition from URL
updateApiDefinitionFromURL 3 params body → 204404
DELETE
/organizations/{organizationId}/apis/{apiId}/versions/{version}/definition
Remove API Definition
deleteApiDefinition 3 params → 204404
DELETE
/organizations/{organizationId}/apis/{apiId}/image
Delete API Image
deleteApiImage 2 params → 204404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/policies/{policyId}
Get API Policy
getApiPolicy 4 params → 200404
PUT
/organizations/{organizationId}/apis/{apiId}/versions/{version}/policies/{policyId}
Update API Policy
updateApiPolicy 4 params body → 204404
DELETE
/organizations/{organizationId}/apis/{apiId}/versions/{version}/policies/{policyId}
Remove API Policy
deleteApiPolicy 4 params → 204404
GET
/organizations/{organizationId}/clients/{clientId}
Get Client By ID
getClient 2 params → 200404
PUT
/organizations/{organizationId}/clients/{clientId}
Update Client
updateClient 2 params body → 204404
DELETE
/organizations/{organizationId}/clients/{clientId}
Delete a client
deleteClient 2 params → 204409
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/policies/{policyId}
Get Client Policy
getClientPolicy 4 params → 200404
PUT
/organizations/{organizationId}/clients/{clientId}/versions/{version}/policies/{policyId}
Update Client Policy
updateClientPolicy 4 params body → 204404
DELETE
/organizations/{organizationId}/clients/{clientId}/versions/{version}/policies/{policyId}
Remove Client Policy
deleteClientPolicy 4 params → 204404
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts/{contractId}
Get API Contract
getContract 4 params → 200404
DELETE
/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts/{contractId}
Break Contract
deleteContract 4 params → 204404
GET
/organizations/{organizationId}
Get Organization By ID
getOrg 1 param → 200404
PUT
/organizations/{organizationId}
Update Organization By ID
updateOrg 1 param body → 200404
DELETE
/organizations/{organizationId}
Delete an organization
deleteOrg 1 param → 204409
GET
/organizations/{organizationId}/plans/{planId}
Get Plan By ID
getPlan 2 params → 200404
PUT
/organizations/{organizationId}/plans/{planId}
Update Plan
updatePlan 2 params body → 204404
DELETE
/organizations/{organizationId}/plans/{planId}
Delete Plan
deletePlan 2 params → 204404409
GET
/organizations/{organizationId}/plans/{planId}/versions/{version}/policies/{policyId}
Get Plan Policy
getPlanPolicy_1 4 params → 200404
PUT
/organizations/{organizationId}/plans/{planId}/versions/{version}/policies/{policyId}
Update Plan Policy
updatePlanPolicy 4 params body → 204404
DELETE
/organizations/{organizationId}/plans/{planId}/versions/{version}/policies/{policyId}
Remove Plan Policy
deletePlanPolicy 4 params → 204404
GET
/organizations/{organizationId}/apis/{apiId}/activity
Get API Activity
getApiActivity 4 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/plans/{planId}/policyChain
Get API Policy Chain
getApiPolicyChain 4 params → 200404
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/apiregistry/json
Get API Registry (JSON)
getApiRegistryJSON 4 params → 200404
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/apiregistry/xml
Get API Registry (XML)
getApiRegistryXML 4 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}
Get API Version
getApiVersion_1 3 params → 200404
PUT
/organizations/{organizationId}/apis/{apiId}/versions/{version}
Update API Version
updateApiVersion 3 params body → 204404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/activity
Get API Version Activity
getApiVersionActivity 5 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/contracts
List API Contracts
getApiVersionContracts 5 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/endpoint
Get API Endpoint
getApiVersionEndpointInfo_1 3 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/plans
List API Plans
getApiVersionPlans_1 3 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/status
Get API Version Status
getApiVersionStatus 3 params → 200404
GET
/organizations/{organizationId}/clients/{clientId}/activity
Get Client Activity
getClientActivity 4 params → 200404
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/apikey
Get API Key
getClientApiKey 3 params → 200404
PUT
/organizations/{organizationId}/clients/{clientId}/versions/{version}/apikey
Update API Key
updateClientApiKey 3 params body → 200404409
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/metrics/apiUsage
Get Client Usage Metrics (per API)
getClientUsagePerApi 5 params → 200
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}
Get Client Version
getClientVersion 3 params → 200404
GET
/organizations/{organizationId}/clients/{clientId}/versions/{version}/activity
Get Client Version Activity
getClientVersionActivity 5 params → 200404
GET
/organizations/{organizationId}/activity
Get Organization Activity
getOrgActivity 3 params → 200404
GET
/organizations/{organizationId}/plans/{planId}/activity
Get Plan Activity
getPlanActivity 4 params → 200404
GET
/organizations/{organizationId}/plans/{planId}/versions/{version}
Get Plan Version
getPlanVersion 3 params → 200404
GET
/organizations/{organizationId}/plans/{planId}/versions/{version}/activity
Get Plan Version Activity
getPlanVersionActivity 5 params → 200404
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/responseStats
Get API Response Statistics (Histogram)
getResponseStats 6 params → 200
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/clientResponseStats
Get API Response Statistics (per Client)
getResponseStatsPerClient 5 params → 200
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/planResponseStats
Get API Response Statistics (per Plan)
getResponseStatsPerPlan 5 params → 200
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/summaryResponseStats
Get API Response Statistics (Summary)
getResponseStatsSummary 5 params → 200
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/usage
Get API Usage Metrics
getUsage 6 params → 200
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/clientUsage
Get API Usage Metrics (per Client)
getUsagePerClient 5 params → 200
GET
/organizations/{organizationId}/apis/{apiId}/versions/{version}/metrics/planUsage
Get API Usage Metrics (per Plan)
getUsagePerPlan 5 params → 200
POST
/organizations/{organizationId}/roles
Grant Membership(s)
grant 1 param body → 204
GET
/organizations/{organizationId}/members
List Organization Members
listMembers 1 param → 200
POST
/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts/{contractId}/policies/{policyId}
Probe a policy associated with a contract
probeContractPolicy 5 params body → 200
PUT
/organizations/{organizationId}/apis/{apiId}/versions/{version}/reorderApiPlans
Reorder API plans
reorderApiPlans 3 params body → 200404401
POST
/organizations/{organizationId}/apis/{apiId}/versions/{version}/reorderPolicies
Re-Order API Policies
reorderApiPolicies 3 params body → 204404
POST
/organizations/{organizationId}/clients/{clientId}/versions/{version}/reorderPolicies
Re-Order Client Policies
reorderClientPolicies 3 params body → 204404
POST
/organizations/{organizationId}/plans/{planId}/versions/{version}/reorderPolicies
Re-Order Plan Policies
reorderPlanPolicies 3 params body → 204404
DELETE
/organizations/{organizationId}/roles/{roleId}/{userId}
Revoke Single Membership
revoke 3 params → 204
DELETE
/organizations/{organizationId}/members/{userId}
Revoke All Memberships
revokeAll 2 params → 204404
PUT
/organizations/{organizationId}/apis/{apiId}/tags
Tag an API
tagApi 2 params body → 200

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are ApiVersionBean (24 properties), ApiVersionBeanDto (23 properties), ContractSummaryBean (17 properties), PolicyBean (14 properties). Each schema is shown below with its type and property counts.

PolicyDefinitionTemplateBean
object
2 properties
ApiPlanBeanDto
object
4 properties 2 required
UsagePerPlanBean
object
1 property
PolicySummaryBean
object
7 properties
MemberBean
object
5 properties
ContractSummaryBean
object
17 properties
ApiPlanSummaryBean
object
6 properties
ApiPlanOrderDto
object
1 property
UsageDataPoint
object
2 properties
PolicyChainBean
object
Models an ordered list of policies that would be applied if an API were invoked via a particular plan
1 property
NewOrganizationBean
object
2 properties
UpdateApiPlanDto
object
4 properties 2 required
UpdateApiBean
object
4 properties
ApiVersionEndpointSummaryBean
object
1 property
ApiBean
object
9 properties
AuditEntryBean
object
9 properties
ClientVersionBean
object
11 properties
ApiDefinitionBean
object
3 properties
ContractBean
object
7 properties
UpdateClientBean
object
1 property
UpdatePlanBean
object
1 property
UsageHistogramBean
object
1 property
PlanVersionSummaryBean
object
7 properties
ApiVersionSummaryBean
object
11 properties
SearchResultsBeanAuditEntryBean
object
2 properties
ClientBean
object
7 properties
ApiVersionBean
object
24 properties
OrganizationBean
object
7 properties
ApiGatewayBean
object
1 property
UpdateApiVersionBean
object
11 properties
NewClientBean
object
3 properties
GrantRolesBean
object
2 properties
NewApiBean
object
14 properties
StatusItemBean
object
5 properties
ClientVersionSummaryBean
object
8 properties
ResponseStatsHistogramBean
object
1 property
KeyValueTag
object
3 properties
ResponseStatsSummaryBean
object
3 properties
PlanVersionBean
object
9 properties
ApiVersionStatusBean
object
2 properties
UpdatePolicyBean
object
Update a policy
1 property
NewPlanVersionBean
object
3 properties
PlanSummaryBean
object
5 properties
ResponseStatsPerClientBean
object
1 property
NewPlanBean
object
3 properties
KeyValueTagDto
object
Key value tag pair
2 properties 1 required
UsagePerClientBean
object
1 property
ApiKeyBean
object
1 property
PlanBean
object
6 properties
NewPolicyBean
object
Payload for creating a new policy for a Plan, API, or Client
2 properties
ApiVersionBeanDto
object
23 properties 14 required
ApiSummaryBean
object
8 properties
NewContractBean
object
Required information to create a new Contract.
4 properties
PolicyDefinitionBean
object
10 properties
NewClientVersionBean
object
4 properties
ClientUsagePerApiBean
object
1 property
NewApiDefinitionBean
object
2 properties
NewApiVersionBean
object
Initial information to create a new API version.
13 properties 1 required
PolicyBean
object
14 properties
UpdateOrganizationBean
object
1 property
MemberRoleBean
object
2 properties
ResponseStatsPerPlanBean
object
1 property
ClientSummaryBean
object
7 properties
ApiPlanBean
object
4 properties
ResponseStatsDataPoint
object
4 properties
ApiBeanDto
object
9 properties
ApiPlanOrderEntryDto
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiman-organizations-api-openapi.yml Raw ↑

Other APIs Apiman publishes across the network.

Apiman Actions API
Apiman Blobs API
Apiman Developers API
Apiman Devportal API
Apiman Downloads API
Apiman Events API
Apiman Experimental API
Apiman Gateways API
Apiman Plugins API
Apiman Policy Definitions API
Apiman Roles API
Where this information came from

This is an independent, third-party profile of Apiman Organizations 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.