Get all APIs

Deprecated

GET

/apis

GET

/apis

$ curl -G https://api.getpostman.com/apis \
>      -H "Accept: application/vnd.api.v10+json" \
>      -H "x-api-key: <apiKey>" \
>      -d workspaceId=1f0df51a-8658-4ee8-a2a1-d2567dfa09a9

1 {
2   "apis": [
3     {
4       "id": "73e15000-bc7a-4802-b80e-05fff18fd7f8",
5       "name": "New API",
6       "summary": "",
7       "createdAt": "2023-02-15T06:27:16.000Z",
8       "createdBy": 12345678,
9       "updatedAt": "2023-02-15T06:27:24.000Z",
10       "updatedBy": 12345678,
11       "description": ""
12     },
13     {
14       "id": "fec65321-5f55-4feb-8525-be95bccae8dd",
15       "name": "Test API",
16       "summary": "This is a test API.",
17       "createdAt": "2023-02-15T13:07:08.000Z",
18       "createdBy": 12345678,
19       "updatedAt": "2023-02-15T13:07:08.000Z",
20       "updatedBy": 12345678,
21       "description": "This is an API for testing purposes."
22     },
23     {
24       "id": "b7c54faa-d119-4572-a18d-e2f5c32348ce",
25       "name": "Test API",
26       "summary": "This is a test API.",
27       "createdAt": "2023-02-16T05:52:27.000Z",
28       "createdBy": 12345678,
29       "updatedAt": "2023-02-16T05:52:27.000Z",
30       "updatedBy": 12345678,
31       "description": "This is an API for testing purposes."
32     },
33     {
34       "id": "d535a8ba-ed4b-4c6a-bf1c-13fac95485b8",
35       "name": "Test API",
36       "summary": "This is a test API.",
37       "createdAt": "2023-02-16T07:07:16.000Z",
38       "createdBy": 12345678,
39       "updatedAt": "2023-02-16T07:07:16.000Z",
40       "updatedBy": 12345678,
41       "description": "This is an API for testing purposes."
42     }
43   ],
44   "meta": {
45     "limit": 10,
46     "total": 4,
47     "nextCursor": "VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk="
48   }
49 }

Gets information about all APIs in a workspace.

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)>.

Query parameters

workspaceIdstringRequired

The workspace's ID.

createdByintegerOptional

Return only results created by the given user ID.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

descriptionstringOptional

Return only APIs whose description includes the given value. Matching is not case-sensitive.

limitintegerOptionalDefaults to 10

The maximum number of rows to return in the response.

Response

Successful Response

apislist of objects

metaobject

The response's meta information for paginated results.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors