Get all elements and folders
GET {{baseUrl}}/network/private
Gets information about the folders and elements added to your [Private API Network] Elements are APIs, collections, and workspaces.
Note:
The limit and offset parameters are separately applied to elements and folders. For example, if you query a limit value of 10 and an offset value 0, the endpoint returns 10 elements and 10 folders for a total of 20 items. The totalCount property in the meta response is the total count of both elements and folders.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
since | string | Return only results created since the given time, in ISO 8601 format. This value cannot be later than the until value. | |
until | string | Return only results created until this given time, in ISO 8601 format. This value cannot be earlier than the since value. | |
addedBy | string | Return only elements published by the given user ID. | |
name | string | Return only elements whose name includes the given value. Matching is not case-sensitive. | |
summary | string | Return only elements whose summary includes the given value. Matching is not case-sensitive. | |
description | string | Return only elements whose description includes the given value. Matching is not case-sensitive. | |
sort | string | Sort the results by the given value. One of: |
createdAtupdatedAt
If you use this query parameter, you must also use the direction parameter. |
| direction | string | | 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. |
| createdBy | string | | Return only the elements created by the given user ID. |
| offset | string | | The zero-based offset of the first item to return. This value defaults to 0. |
| limit | string | | The maximum number of elements to return. If the value exceeds the maximum value of 1000, then the system uses the 1000 value. |
| parentFolderId | string | | Return the folders and elements in a specific folder in the Private API Network. If this value is 0, then the endpoint only returns the root folder's elements. |
| type | string | | Filter by the element type. One of:
folderworkspacecollectionapi|
RESPONSES
status: OK
{"elements":[{"addedAt":"2021-11-29T06:31:24.000Z","addedBy":12345678,"createdBy":12345678,"createdAt":"2020-06-01T08:32:31.000Z","updatedBy":12345678,"updatedAt":"2021-11-29T06:31:24.000Z","type":"api","id":"5360b75f-447e-467c-9299-12fd6c92450d","parentFolderId":1,"name":"Billing API","summary":"The payments and account services API.","description":null,"href":"https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d"},{"addedBy":12345678,"addedAt":"2022-12-07T18:22:15.000Z","createdBy":12345678,"createdAt":"2022-12-07T18:22:15.000Z","updatedBy":12345678,"updatedAt":"2022-12-07T18:22:15.000Z","type":"collection","id":"12ece9e1-2abf-4edc-8e34-de66e74114d2","name":"Billing API Collection","summary":"The Billing API collection.","description":null,"href":"https://api.getpostman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2","parentFolderId":2,"environments":["120403-c6cf0fe2-c637-4d30-a640-ed64ec6d0ddb","7084-461d8126-22c8-43ed-b99d-27e8a34d8eef"]}],"folders":[{"id":1,"parentFolderId":0,"updatedAt":"2021-11-29T06:31:24.000Z","updatedBy":12345678,"createdBy":12345678,"createdAt":"2020-06-01T08:32:31.000Z","name":"Billing","description":"The Billing API.","type":"folder"}],"meta":{"limit":1000,"offset":0,"totalCount":2}}