Postman · Example Payload

Postman Create Api Spec Example

AI Agent BuilderAI AgentsAPI CatalogAPI ClientAPI DesignAPI DevelopmentAPI DocumentationAPI GovernanceAPI LifecycleAPI MonitoringAPI NetworkAPI PlatformAPI TestingAudit LogsAutomationCI/CDCollaborationCollectionsComplianceDiscoveryEnvironmentsFlowsGraphQLgRPCHTTPInsightsMCPMCP GeneratorMock ServersMockingMonitorsNewmanOpenAPIPlatformPrivate API NetworkPublic API NetworkSecret ScanningSpec HubSpecificationsSSOTestingVaultWebSocketWorkflowsWorkspaces

Postman Create Api Spec Example is an example object payload from Postman, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponse

Example Payload

Raw ↑ 
{
  "request": {
    "method": "POST",
    "url": "https://api.getpostman.com/apis?workspace=f8b8f2b1-9f8a-4c4c-9b3e-2a1c1f1d2e3f",
    "headers": {
      "x-api-key": "PMAK-xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "Content-Type": "application/json"
    },
    "body": {
      "api": {
        "name": "Customer API",
        "summary": "Customer onboarding and lifecycle API.",
        "description": "Public Customer API used by partner integrations."
      }
    }
  },
  "response": {
    "status": 201,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "api": {
        "id": "ab12cd34-ef56-7890-1234-567890abcdef",
        "name": "Customer API",
        "summary": "Customer onboarding and lifecycle API.",
        "description": "Public Customer API used by partner integrations.",
        "createdAt": "2026-05-15T10:11:12.000Z",
        "updatedAt": "2026-05-15T10:11:12.000Z",
        "createdBy": "12345678",
        "updatedBy": "12345678"
      }
    }
  }
}