Get an API

Deprecated

GET

/apis/:apiId

Gets information about an API.

Note:

Git-connected APIs will only return the versions and gitInfo query responses. This is because schema and collection information is stored in the connected Git repository. The gitInfo object only lists the repository and folder locations of the files.
API viewers can only use the versions option in the include query parameter.

Gets information about an API. **Note:** - Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository and folder locations of the files. - API viewers can only use the `versions` option in the `include` query parameter.

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

apiIdstringRequired

The API's ID.

Query parameters

includelist of enumsOptional

An array that contains additional resources to include in the response. Use this parameter to query for element links to the API, such as collections and schemas:

collections — Query for linked Postman collections.
versions — Query for linked versions.
schemas — Query for linked schemas.
gitInfo — Query for information about the API’s git-linked repository. This query only returns the linked repository and folder locations of the files. It does not return collections or schemas information.

Note:

API viewers can only use the versions option.

An array that contains additional resources to include in the response. Use this parameter to query for element links to the API, such as collections and schemas: - `collections` — Query for linked Postman collections. - `versions` — Query for linked versions. - `schemas` — Query for linked schemas. - `gitInfo` — Query for information about the API's git-linked repository. This query only returns the linked repository and folder locations of the files. It does not return `collections` or `schemas` information. **Note:** API viewers can only use the `versions` option.

Response

Successful Response

API Dataobject

Extended API Dataobject

The API’s extended data schema.

Note:

Git-connected APIs will only return the versions and gitInfo query responses. This is because schema and collection information is stored in the connected Git repository. The gitInfo object only lists the repository and folder locations of the files.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	{
2	"collections": [
3	{
4	"id": "16bb367e-fafb-4ef3-933b-ee3d971866fb"
5	}
6	],
7	"createdAt": "2022-06-09T14:48:45.000Z",
8	"createdBy": 12345678,
9	"description": "This is a test API.",
10	"gitInfo": {},
11	"id": "5360b75f-447e-467c-9299-12fd6c92450d",
12	"name": "Test API",
13	"schemas": [
14	{
15	"id": "ae2b9ab2-28f2-401d-912f-eca09a78e98b"
16	}
17	],
18	"summary": "Test API.",
19	"updatedAt": "2022-06-09T19:50:49.000Z",
20	"updatedBy": 12345678,
21	"versions": [
22	{
23	"id": "18ccb2dc-1746-4945-ba76-8152b37cr123",
24	"name": "v1.0.0"
25	}
26	]
27	}

$	curl https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002 \
>	-H "Accept: application/vnd.api.v10+json" \
>	-H "x-api-key: <apiKey>"

Authentication

Path parameters

Headers

Query parameters

Response

Errors