Get all mock servers

GET

/mocks

GET

/mocks

$ curl https://api.postman.com/mocks \
>      -H "x-api-key: <apiKey>"

1 {
2   "mocks": [
3     {
4       "id": "e3d951bf-873f-49ac-a658-b2dcb91d3289",
5       "owner": "12345678",
6       "uid": "12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289",
7       "collection": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
8       "mockUrl": "https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io",
9       "config": {
10         "delay": {
11           "type": "fixed",
12           "duration": 140000
13         },
14         "headers": [],
15         "matchBody": false,
16         "matchQueryParams": true,
17         "matchWildcards": true,
18         "serverResponseId": ""
19       },
20       "createdAt": "2022-07-25T20:54:30.000Z",
21       "environment": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e",
22       "isPublic": false,
23       "name": "Test Mock A",
24       "updatedAt": "2022-07-25T20:54:30.000Z"
25     },
26     {
27       "id": "cf0f8f11-fe0e-455f-99f3-4177f10f0704",
28       "owner": "12345678",
29       "uid": "12345678-cf0f8f11-fe0e-455f-99f3-4177f10f0704",
30       "collection": "12345678-2cd8f6b1-e85b-46a6-8111-bd62e73e8aa8",
31       "mockUrl": "https://cf0f8f11-fe0e-455f-99f3-4177f10f0704.mock.pstmn.io",
32       "config": {
33         "delay": null,
34         "headers": [],
35         "matchBody": false,
36         "matchQueryParams": true,
37         "matchWildcards": true,
38         "serverResponseId": "94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65",
39         "matchHeader": false
40       },
41       "createdAt": "2023-01-26T18:59:05.000Z",
42       "isPublic": false,
43       "name": "Test Mock B",
44       "updatedAt": "2023-01-26T18:59:05.000Z"
45     }
46   ]
47 }

Gets all active mock servers. By default, this endpoint returns only mock servers you created across all workspaces.

Note:

If you pass both the teamId and workspace query parameters, this endpoint only accepts the workspace query.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

teamIdstringOptional

Return only results that belong to the given team ID.

workspacestringOptional

Return only results found in the given workspace ID.

Response

Successful Response

mockslist of objects

A list of mock servers.

Errors

401

Unauthorized Error

500

Internal Server Error