Get a response

GET

/collections/:collectionId/responses/:responseId

GET

/collections/:collectionId/responses/:responseId

$ curl https://api.postman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/responses/cc364734-7dfd-4bfc-897d-be763dcdbb07 \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": {
3     "id": "cc364734-7dfd-4bfc-897d-be763dcdbb07",
4     "request": "c82dd02c-4870-4907-8fcb-593a876cf05b",
5     "name": "Successful GET Response",
6     "owner": "12345678",
7     "createdAt": "2023-09-07T14:39:52.000Z",
8     "updatedAt": "2023-09-07T14:41:08.000Z",
9     "lastRevision": 32457792182,
10     "lastUpdatedBy": "12345678",
11     "cookies": null,
12     "headers": [
13       {
14         "description": "",
15         "key": "Content-Type",
16         "name": "Content-Type",
17         "type": "text",
18         "value": "application/json"
19       }
20     ],
21     "language": "json",
22     "mime": null,
23     "rawDataType": null,
24     "requestObject": "{\"data\":null,\"dataMode\":\"raw\",\"dataOptions\":{\"raw\":{\"language\":\"json\"}},\"headerData\":[{\"key\":\"Accept\",\"value\":\"application/vnd.example.v1+json\",\"description\":\"\",\"type\":\"text\",\"enabled\":true}],\"method\":\"GET\",\"pathVariableData\":[],\"queryParams\":[{\"key\":\"id\",\"value\":\"test-api\",\"equals\":true,\"description\":null,\"enabled\":true}],\"url\":\"http://api.postman.com/v1/request?id=test-api\",\"headers\":\"Accept: application/vnd.example.v1+json\\n\",\"pathVariables\":{},\"protocolProfileBehavior\":{\"disableBodyPruning\":true},\"rawModeData\":\"\",\"graphqlModeData\":{}}",
25     "responseCode": {
26       "code": 200,
27       "name": "OK"
28     },
29     "status": null,
30     "text": "{\n    \"title\": \"Not Found\",\n    \"detail\": \"Requested API does not exist\",\n    \"type\": \"about:blank\"\n}",
31     "time": null
32   },
33   "meta": {
34     "action": "find",
35     "changeset": false,
36     "model": "response",
37     "populate": false
38   },
39   "model_id": "cc364734-7dfd-4bfc-897d-be763dcdbb07"
40 }

Gets information about a response in a collection.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

responseIdstringRequired

The response'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

dataobject

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

metamap from strings to any

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

model_idstring

The response's ID.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error