{ "opencollection": "1.0.0", "info": { "name": "Postman Private API Network API", "version": "1.0.0" }, "items": [ { "info": { "name": "privateApiNetwork", "type": "folder" }, "items": [ { "info": { "name": "Get all workspaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/network/private", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "query", "description": "The `workspace` value." }, { "name": "name", "value": "", "type": "query", "description": "Return only workspaces whose name includes the given value. Matching is not case-sensitive." }, { "name": "summary", "value": "", "type": "query", "description": "Return only workspaces whose summary includes the given value. Matching is not case-sensitive." }, { "name": "description", "value": "", "type": "query", "description": "Return only workspaces whose description includes the given value. Matching is not case-sensitive." }, { "name": "since", "value": "", "type": "query", "description": "Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value." }, { "name": "until", "value": "", "type": "query", "description": "Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value." }, { "name": "addedBy", "value": "", "type": "query", "description": "Return only workspaces published by the given user ID." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this query parameter, you must also use the `sort` parameter." }, { "name": "createdBy", "value": "", "type": "query", "description": "Return only results created by the given user ID." }, { "name": "offset", "value": "", "type": "query", "description": "The zero-based offset of the first item to return." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value." }, { "name": "parentFolderId", "value": "", "type": "query", "description": "This parameter is deprecated." } ] }, "docs": "Gets information workspaces added to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/)." }, { "info": { "name": "Add a workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.postman.com/network/private", "headers": [ { "name": "x-api-key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publishes a workspace in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/)." }, { "info": { "name": "Update an element or folder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.postman.com/network/private/workspace/:workspaceId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**This endpoint is deprecated.**\n" }, { "info": { "name": "Remove a workspace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.postman.com/network/private/workspace/:workspaceId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ] }, "docs": "Removes a workspace from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).\n\n**Note:**\n\nRemoving a workspace does not delete it. It only removes it from the Private API Network folder.\n" }, { "info": { "name": "Get all add requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/network/private/network-entity/request/all", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "since", "value": "", "type": "query", "description": "Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character." }, { "name": "until", "value": "", "type": "query", "description": "Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character." }, { "name": "requestedBy", "value": "", "type": "query", "description": "Return a user's requests by their user ID." }, { "name": "type", "value": "", "type": "query", "description": "The `workspace` value." }, { "name": "status", "value": "", "type": "query", "description": "Filter by the request status." }, { "name": "name", "value": "", "type": "query", "description": "Return only workspaces whose name includes the given value. Matching is not case-sensitive." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this query parameter, you must also use the `sort` parameter." }, { "name": "offset", "value": "", "type": "query", "description": "The zero-based offset of the first item to return." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value." } ] }, "docs": "Gets all requests to add workspaces to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/)." }, { "info": { "name": "Respond to an add request", "type": "http" }, "http": { "method": "PUT", "url": "https://api.postman.com/network/private/network-entity/request/:requestId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Responds to a user's request to add a workspace to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). Only managers can approve or deny a request. Once approved, the workspace will appear in the team's Private API Network." } ] } ], "bundled": true }