30-day challenge API Documentation
Get all element add requests
GET https://api.getpostman.com/network/private/network-entity/request/all
Gets a list requests to add elements to the [Private API Network]
Body
PARAM
| Key | Datatype | Required | Description |
since
|
string | Optional. Return only elements updated at and after this time, in ISO 8601 UTC format. | |
until
|
string | Optional. Return only elements updated at and before this time, in ISO 8601 UTC format. | |
requestedBy
|
string | Optional. Return a user's element requests by their user ID. | |
type
|
string | Optional. Filter by the element type. One of: `workspace`, `collection`, `api`. | |
status
|
string | Optional. Filter by the request status. One of: `pending`, `denied`. | |
name
|
string | Optional. Return only elements whose name includes the given value. Matching is not case-sensitive. | |
sort
|
string | Optional. Sort the results by the `name` or `updatedAt` properties. 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. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
X-API-Key
|
string |
RESPONSES
status OK
| {
"requests": [
{
"id": 1,
"createdBy": 87654321,
"createdAt": "2020-06-01T08:32:31.000Z",
"status": "pending",
"element": {
"type": "api",
"id": "360b75f-447e-467c-9299-12fd3c92450d",
"name": "Test api",
"summary": "Test api summary"
}
},
{
"id": 2,
"createdBy": 12345678,
"createdAt": "2022-06-09T14:48:45.000Z",
"message": "Please approve this collection",
"status": "denied",
"element": {
"type": "collection",
"id": "5360b75f-447e-467c-9299-12fd3c92450d",
"name": "Test Collection",
"summary": "This is a test collection."
},
"response": {
"createdAt": "2020-06-01T08:32:31.000Z",
"createdBy": 2272,
"message": "Too many errors, please fix and resubmit"
}
}
],
"meta": {
"limit": 10,
"offset": 5,
"totalCount": 100
}
} |
Curl
curl -X GET 'https://api.getpostman.com/network/private/network-entity/request/all?since=undefined&until=undefined&requestedBy=undefined&type=undefined&status=undefined&name=undefined&sort=undefined&direction=undefined&offset=undefined&limit=undefined' -H 'X-API-Key: undefined'
ENDPOINTS