APIs.io Engineering Platform Apis API

The Apis API from APIs.io Engineering Platform — 4 operation(s) for apis.

Operations 7

GET /apis APIs.io Engineering Platform Get all APIs #
POST /apis APIs.io Engineering Platform Create an API #
GET /apis/{apiId} APIs.io Engineering Platform Get an API #
PUT /apis/{apiId} APIs.io Engineering Platform Update an API #
DELETE /apis/{apiId} APIs.io Engineering Platform Delete an API #
GET /apis/{apiId}/tasks/{taskId} APIs.io Engineering Platform Get status of an asynchronous task #
GET /apis/{apiId}/versions/{versionId} APIs.io Engineering Platform Get a version #

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/engineering-platform-apis-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

engineering-platform-apis-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: .io Engineering Platform Postman APIS API
  description: "The Postman API enables you to programmatically access data stored in your Postman account.\n\n> Certain endpoints may be unavailable depending on your region and/or Postman plan.\n\nFor a comprehensive set of examples of requests and responses, see the [**Postman API** collection](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a).\n\n## Getting started\n\nYou can get started with the Postman API by creating a copy of this definition in your workspace.\n\n### EU users\n\nFor users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.\n\n## About the Postman API\n\n- You must use a valid API Key to send requests to the API endpoints.\n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.\n- The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n- The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.\n- For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.\n- When calling the API Builder endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value.\n\n### IDs and UIDs\n\nAll items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:\n\n- An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.\n- The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID:\n    - `12345678` is the user's ID.\n    - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.\n\n### Enum values\n\nAny documented enum values should be considered partial lists and may change over time.\n\n### 403 response for unavailable features\n\nDepending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the \"This feature isn't available in your region.\" detail.\n\n### 503 response\n\nAn HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.\n\nIf the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Authentication\n\nPostman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.\n\nYou must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will use it to make API calls.\n\n### SCIM authentication\n\nWhile all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Rate and usage limits\n\nAPI access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. Postman Monitors, the GET `/collections`, and the GET `/workspaces` endpoint have a rate limit of **10 calls in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/).\n\nWhen you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:\n\n- `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API.\n- `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.\n\n## Support\n\nFor help regarding accessing the Postman API, you can:\n\n- Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.\n- Reach out to the [Postman community](https://community.postman.com/).\n- Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Policies\n\n- [Postman Terms of Service](http://www.postman.com/legal/terms/)\n- [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)\n"
  version: '1.0'
  termsOfService: https://www.postman.com/legal/terms/
  contact:
    name: Postman Support
    email: help@postman.com
    url: https://www.postman.com/community/
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
security:
- PostmanApiKey: []
- scimApiKey: []
tags:
- name: Apis
paths:
  /apis:
    parameters:
    - $ref: '#/components/parameters/workspaceIdQueryTrue'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get all APIs
      description: Gets information about all APIs in a workspace.
      operationId: getApis
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getApis'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/workspaceIdQueryTrue'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/apiDescription'
      - $ref: '#/components/parameters/limit'
    post:
      summary: APIs.io Engineering Platform Create an API
      description: Creates an API.
      operationId: createApi
      tags:
      - Apis
      requestBody:
        $ref: '#/components/requestBodies/createApi'
      responses:
        '200':
          $ref: '#/components/responses/createApi'
        '400':
          $ref: '#/components/responses/workspace400ErrorParamMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/api403ErrorForbidden'
                - $ref: '#/components/schemas/api403ErrorLimitReached'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/api403ErrorForbidden'
                API Limit Reached:
                  $ref: '#/components/examples/api403ErrorLimitReached'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/workspace404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get an API
      description: 'Gets information about an API.


        **Note:**


        - Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository and folder locations of the files.

        - API viewers can only use the `versions` option in the `include` query parameter.

        '
      operationId: getApi
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getApi'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiInclude'
    put:
      summary: APIs.io Engineering Platform Update an API
      description: Updates an API.
      operationId: updateApi
      tags:
      - Apis
      requestBody:
        $ref: '#/components/requestBodies/updateApi'
      responses:
        '200':
          $ref: '#/components/responses/updateApi'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete an API
      description: Deletes an API. On success, this returns an HTTP `204 No Content` response.
      operationId: deleteApi
      tags:
      - Apis
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/api404ErrorNotFound'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/tasks/{taskId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiTaskId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get status of an asynchronous task
      description: Gets the status of an asynchronous task.
      operationId: getStatusOfAnAsyncTask
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getStatusOfAnAsyncTask'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiVersion400ErrorInvalidParam'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Invalid Parameter:
                  $ref: '#/components/examples/apiVersion400ErrorInvalidParam'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/taskNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/versions/{versionId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiVersionId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get a version
      description: 'Gets information about an API version.


        **Note:**


        - For API editors, this endpoint returns an HTTP `302 Found` status code when the version status is pending. It also returns the `/apis/{apiId}/tasks/{taskId}` task status response header.

        - For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending.

        '
      operationId: getApiVersion
      tags:
      - Apis
      responses:
        '200':
          $ref: '#/components/responses/getApiVersion'
        '302':
          description: Found
          headers:
            Location:
              $ref: '#/components/headers/Location'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/apiVersion404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  responses:
    getApis:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the API schema.
            properties:
              apis:
                type: array
                items:
                  type: object
                  title: API Base Data Schema
                  description: The API's base data schema.
                  properties:
                    id:
                      type: string
                      description: The API's ID.
                      example: 5360b75f-447e-467c-9299-12fd6c92450d
                    name:
                      type: string
                      description: The API's name.
                      example: User Management API
                    summary:
                      type: string
                      description: The API's short summary.
                      example: An API to manager users.
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the API was created.
                      example: '2023-08-22T14:21:57.000Z'
                    createdBy:
                      type: integer
                      description: The Postman ID of the user that created the API.
                      example: 12345678
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the API was updated.
                      example: '2023-08-22T14:21:57.000Z'
                    updatedBy:
                      type: integer
                      description: The Postman ID of the user that updated the API.
                      example: 12345678
                    description:
                      type: string
                      description: The API's description.
                      example: This API includes operations to add/remove/update users.
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  limit:
                    type: number
                    example: 100
                    description: The maximum number of records in the paginated response.
                  total:
                    type: number
                    example: 1000
                    description: The number of records that match the defined criteria.
                  nextCursor:
                    type: string
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
          example:
            meta:
              nextCursor: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
              total: 4
              limit: 10
            apis:
            - updatedBy: 12345678
              createdBy: 12345678
              name: New API
              summary: ''
              description: ''
              createdAt: '2023-02-15T06:27:16.000Z'
              id: 73e15000-bc7a-4802-b80e-05fff18fd7f8
              updatedAt: '2023-02-15T06:27:24.000Z'
            - updatedBy: 12345678
              createdBy: 12345678
              name: Test API
              summary: This is a test API.
              description: This is an API for testing purposes.
              createdAt: '2023-02-15T13:07:08.000Z'
              id: fec65321-5f55-4feb-8525-be95bccae8dd
              updatedAt: '2023-02-15T13:07:08.000Z'
            - updatedBy: 12345678
              createdBy: 12345678
              name: Test API
              summary: This is a test API.
              description: This is an API for testing purposes.
              createdAt: '2023-02-16T05:52:27.000Z'
              id: b7c54faa-d119-4572-a18d-e2f5c32348ce
              updatedAt: '2023-02-16T05:52:27.000Z'
            - updatedBy: 12345678
              createdBy: 12345678
              name: Test API
              summary: This is a test API.
              description: This is an API for testing purposes.
              createdAt: '2023-02-16T07:07:16.000Z'
              id: d535a8ba-ed4b-4c6a-bf1c-13fac95485b8
              updatedAt: '2023-02-16T07:07:16.000Z'
    updateApi:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the API.
            required:
            - name
            properties:
              id:
                type: string
                description: The API's ID.
                example: 5360b75f-447e-467c-9299-12fd6c92450d
              name:
                type: string
                description: The API's name.
                example: Test API A
              summary:
                type: string
                description: The API's summary.
                example: Test API A Schema
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the API was created.
                example: '2022-06-29T20:46:58.000Z'
              createdBy:
                type: string
                description: The user ID of the user that created the API.
                example: '12345678'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the API was last updated.
                example: '2022-06-29T20:46:58.000Z'
              updatedBy:
                type: string
                description: The user ID of the user that updated the API.
                example: '12345678'
              description:
                type: string
                description: The API's description. This supports Markdown formatting.
                example: This is Test API A.
          example:
            createdAt: '2022-06-29T20:46:58.000Z'
            updatedAt: '2022-06-29T20:46:58.000Z'
            id: 5360b75f-447e-467c-9299-12fd6c92450d
            name: Test API A
            summary: Test API A Schema
            description: This is Test API A.
            createdBy: '12345678'
            updatedBy: '12345678'
    v10HeaderMissing:
      description: Missing v10 Accept Header
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/v10HeaderMissing'
          examples:
            Missing v10 Accept Header:
              $ref: '#/components/examples/v10HeaderMissing'
    common401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    workspace400ErrorParamMissing:
      description: Missing Workspace ID
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: paramMissingError
              title:
                type: string
                description: A short summary of the problem.
                example: Parameter is missing in the request.
              detail:
                type: string
                description: Information about the error.
                example: Parameter, workspaceId is missing in the request.
          example:
            type: paramMissingError
            title: Parameter is missing in the request.
            detail: Parameter, workspaceId is missing in the request.
    getApi:
      description: Successful Response
      content:
        application/json:
          schema:
            anyOf:
            - type: object
              title: API Base Data Schema
              description: The API's base data schema.
              properties:
                id:
                  type: string
                  description: The API's ID.
                  example: 5360b75f-447e-467c-9299-12fd6c92450d
                name:
                  type: string
                  description: The API's name.
                  example: User Management API
                summary:
                  type: string
                  description: The API's short summary.
                  example: An API to manager users.
                createdAt:
                  type: string
                  format: date-time
                  description: The date and time at which the API was created.
                  example: '2023-08-22T14:21:57.000Z'
                createdBy:
                  type: integer
                  format: int64
                  description: The Postman ID of the user that created the API.
                  example: 12345678
                updatedAt:
                  type: string
                  format: date-time
                  description: The date and time at which the API was updated.
                  example: '2023-08-22T14:21:57.000Z'
                updatedBy:
                  type: integer
                  format: int64
                  description: The Postman ID of the user that updated the API.
                  example: 12345678
                description:
                  type: string
                  description: The API's description.
                  example: This API includes operations to add/remove/update users.
            - type: object
              title: API Extended Data Schema
              description: 'The API''s extended data schema.


                **Note:**


                Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository and folder locations of the files.

                '
              allOf:
              - type: object
                title: API Base Data Schema
                description: The API's base data schema.
                properties:
                  id:
                    type: string
                    description: The API's ID.
                    example: 5360b75f-447e-467c-9299-12fd6c92450d
                  name:
                    type: string
                    description: The API's name.
                    example: User Management API
                  summary:
                    type: string
                    description: The API's short summary.
                    example: An API to manager users.
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the API was created.
                    example: '2023-08-22T14:21:57.000Z'
                  createdBy:
                    type: integer
                    format: int64
                    description: The Postman ID of the user that created the API.
                    example: 12345678
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the API was updated.
                    example: '2023-08-22T14:21:57.000Z'
                  updatedBy:
                    type: integer
                    format: int64
                    description: The Postman ID of the user that updated the API.
                    example: 12345678
                  description:
                    type: string
                    description: The API's description.
                    example: This API includes operations to add/remove/update users.
              - type: object
                title: API Details
                description: Detailed information about the API.
                properties:
                  gitInfo:
                    type: object
                    title: Git Repo Data Schema
                    description: Information about the API's Git repository integration.
                    properties:
                      domain:
                        type:
                        - string
                        - 'null'
                        description: The domain at which the Git repository is hosted.
                        example: https://git.example.com
                      repository:
                        type: string
                        description: The repository's name.
                        example: test-api-repo
                      organization:
                        type: string
                        description: The organization that owns the repository.
                        example: test-org
                      schemaFolder:
                        type: string
                        description: The API definition's repository folder location.
                        example: test-api-schema
                      collectionFolder:
                        type: string
                        description: The API definition's collection repository folder location.
                        example: test-api-collection
                  schemas:
                    type: array
                    description: The API's schemas.
                    items:
                      type: object
                      description: Information about the schema.
                      properties:
                        id:
                          type: string
                          description: The schema's ID.
                          example: 5381f010-c4c1-11ed-afa1-0242ac120002
                  versions:
                    type: array
                    description: The API's versions.
                    items:
                      type: object
                      description: Information about the version.
                      properties:
                        id:
                          type: string
                          description: The version's ID.
                          example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                        name:
                          type: string
                          description: The version's name.
                          example: v1
                  collections:
                    type: array
                    description: The API's collections.
                    items:
                      type: object
                      description: Information about the collection.
                      properties:
                        id:
                          type: string
                          description: The collection's ID.
                          example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002
          example:
            createdBy: 12345678
            name: Test API
            updatedBy: 12345678
            updatedAt: '2022-06-09T19:50:49.000Z'
            description: This is a test API.
            id: 5360b75f-447e-467c-9299-12fd6c92450d
            collections:
            - id: 16bb367e-fafb-4ef3-933b-ee3d971866fb
            gitInfo: {}
            schemas:
            - id: ae2b9ab2-28f2-401d-912f-eca09a78e98b
            versions:
            - id: 18ccb2dc-1746-4945-ba76-8152b37cr123
              name: v1.0.0
            createdAt: '2022-06-09T14:48:45.000Z'
            summary: Test API.
    taskNotFound:
      description: Task Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/taskNotFound'
          examples:
            Task Not Found:
              $ref: '#/components/examples/taskNotFound'
    workspace404Error:
      description: Workspace Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The type of error.
                example: instanceNotFoundError
              title:
                type: string
                description: A short summary of the problem.
                example: We could not find the workspace you are looking for
              detail:
                type: string
                description: Information about the error.
                example: We could not find the workspace you are looking for.
          example:
            title: We could not find the workspace you are looking for
            detail: We could not find the workspace you are looking for.
            type: instanceNotFoundError
    api401ErrorUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: An API key mus

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-apis-api-openapi.yml