Get all add requests

GET

/network/private/network-entity/request/all

GET

/network/private/network-entity/request/all

curl -G https://api.postman.com/network/private/network-entity/request/all \
     -H "x-api-key: <apiKey>" \
     -d direction=asc \
     -d limit=10 \
     -d name=billing \
     -d offset=5 \
     -d requestedBy=12345678 \
     --data-urlencode since=2022-06-01T00:00:00.000Z \
     -d sort=updatedAt \
     -d status=pending \
     -d type=workspace \
     --data-urlencode until=2022-06-15T00:00:00.000Z

{
  "requests": [
    {
      "id": 1,
      "createdAt": "2024-06-01T08:32:31.000Z",
      "createdBy": 87654321,
      "status": "pending",
      "element": {
        "id": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9",
        "type": "workspace",
        "name": "Billing Team Workspace",
        "summary": "The Billing team's workspace."
      }
    },
    {
      "id": 2,
      "createdAt": "2024-06-09T14:48:45.000Z",
      "createdBy": 56781234,
      "message": "Please approve this workspace",
      "status": "denied",
      "element": {
        "id": "360b75f-447e-467c-9299-12fd3c92450d",
        "type": "workspace",
        "name": "Test Workspace",
        "summary": "This is a test workspace."
      },
      "response": {
        "createdAt": "2024-06-01T08:32:31.000Z",
        "createdBy": 12345678,
        "message": "Too many errors, please fix and resubmit"
      }
    }
  ],
  "meta": {
    "limit": 2,
    "offset": 0,
    "totalCount": 10
  }
}

Gets all requests to add workspaces to your team’s Private API Network.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

sincedatetimeOptional

Return only results created since the given time, in ISO 8601 format. This value cannot be later than the until value. To use time-numoffset format, you must use %2B URL-encoding for the + character.

untildatetimeOptional

Return only results created until this given time, in ISO 8601 format. This value cannot be earlier than the since value. To use time-numoffset format, you must use %2B URL-encoding for the + character.

requestedByintegerOptional

Return a user's requests by their user ID.

typeenumOptional

The workspace value.

Allowed values:

statusenumOptional

Filter by the request status.

Allowed values:

namestringOptional

Return only workspaces whose name includes the given value. Matching is not case-sensitive.

sortenumOptional

Sort the results by the given value. If you use this query parameter, you must also use the direction parameter.

Allowed values:

directionenumOptional

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.

Allowed values:

offsetintegerOptionalDefaults to 0

The zero-based offset of the first item to return.

limitintegerOptionalDefaults to 1000

The maximum number of results to return. If the value exceeds the maximum value of 1000, then the system uses the 1000 value.

Response

Successful Response

requestslist of objectsOptional

A list of requests to add elements to the Private API Network.

metaobjectOptional

The response’s non-standard meta information.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error