Qodex.ai

Get all elements and folders

GET https://api.getpostman.com/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

KeyDatatypeRequiredDescription
sincestringOptional. Return only elements updated at and after this time, in ISO 8601 UTC format.
untilstringOptional. Return only elements updated at and before this time, in ISO 8601 UTC format.
addedBystringOptional. Return only elements published by the given user ID.
namestringOptional. Return only elements whose name includes the given value. Matching is not case-sensitive.
summarystringOptional. Return only elements whose summary includes the given value. Matching is not case-sensitive.
descriptionstringOptional. Return only elements whose description includes the given value. Matching is not case-sensitive.
sortstringOptional. Sort the results by the given value. One of:
  • createdAt
  • updatedAt

If you use this query parameter, you must also use the direction parameter. | | direction | string | | Optional. 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 | | Optional. Return only the elements created by the given user ID. | | offset | string | | Optional. The zero-based offset of the first item to return. This value defaults to 0. | | limit | string | | Optional. 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 | | Optional. 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 | | Optional. Filter by the element type. One of:

  • folder
  • workspace
  • collection
  • api |

HEADERS

KeyDatatypeRequiredDescription
X-API-Keynull

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"}],"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}}