Get a request

GET

/collections/:collectionId/requests/:requestId

GET

/collections/:collectionId/requests/:requestId

$ curl https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/c82dd02c-4870-4907-8fcb-593a876cf05b \
>      -H "x-api-key: <apiKey>"

1 {
2   "model_id": "c82dd02c-4870-4907-8fcb-593a876cf05b",
3   "meta": {
4     "action": "find",
5     "changeset": false,
6     "model": "request",
7     "populate": false
8   },
9   "data": {
10     "id": "c82dd02c-4870-4907-8fcb-593a876cf05b",
11     "name": "Example GET Request",
12     "owner": "12345678",
13     "lastRevision": 32206434799,
14     "lastUpdatedBy": "12345678",
15     "createdAt": "2023-08-22T12:52:01.000Z",
16     "updatedAt": "2023-08-22T12:52:11.000Z",
17     "auth": null,
18     "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
19     "currentHelper": null,
20     "data": null,
21     "dataDisabled": false,
22     "dataMode": null,
23     "description": "This is an example GET request.",
24     "descriptionFormat": null,
25     "events": null,
26     "folder": null,
27     "headerData": [],
28     "headers": null,
29     "helperAttributes": null,
30     "method": "GET",
31     "pathVariableData": [],
32     "pathVariables": {},
33     "preRequestScript": null,
34     "protocolProfileBehavior": {
35       "disableBodyPruning": true
36     },
37     "queryParams": [
38       {
39         "description": "Optional. The user's ID.",
40         "enabled": true,
41         "equals": true,
42         "key": "id",
43         "value": "{{id}}"
44       }
45     ],
46     "rawModeData": null,
47     "responses_order": [],
48     "tests": "var data = JSON.parse(responseBody);",
49     "url": "https://postman-echo.com/get",
50     "variables": null
51   }
52 }

Gets information about a request in a collection.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

requestIdstringRequired

The request's ID.

collectionIdstringRequired

The collection's ID.

Query parameters

idsbooleanOptional

If true, returns only properties that contain ID values in the response.

uidbooleanOptional

If true, returns all IDs in UID format (userId-id).

populatebooleanOptional

If true, returns all of the collection item's contents.

Response

Successful Response

model_idstring

The request's ID.

metamap from strings to any

A Postman-specific response that contains information about the internal performed operation.

dataobject

Information about the request. For a complete list of properties, refer to the Request entry in the Postman Collection Format documentation.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error