GetApi

GetApi1

The API's base data schema.

Properties

Name	Type	Required	Description
id	string	❌	The API's ID.
name	string	❌	The API's name.
summary	string	❌	The API's short summary.
createdAt	string	❌	The date and time at which the API was created.
createdBy	number	❌	The Postman ID of the user that created the API.
updatedAt	string	❌	The date and time at which the API was updated.
updatedBy	number	❌	The Postman ID of the user that updated the API.
description	string	❌	The API's description.

GetApi2

Properties

Name	Type	Required	Description
id	string	❌	The API's ID.
name	string	❌	The API's name.
summary	string	❌	The API's short summary.
createdAt	string	❌	The date and time at which the API was created.
createdBy	number	❌	The Postman ID of the user that created the API.
updatedAt	string	❌	The date and time at which the API was updated.
updatedBy	number	❌	The Postman ID of the user that updated the API.
description	string	❌	The API's description.
gitInfo	GitInfo	❌	Information about the API's Git repository integration.
schemas	GetApi2Schemas[]	❌	The API's schemas.
versions	GetApi2Versions[]	❌	The API's versions.
collections	GetApi2Collections[]	❌	The API's collections.

GitInfo

Information about the API's Git repository integration.

Properties

Name	Type	Required	Description
domain	string	❌	The domain at which the Git repository is hosted.
repository	string	❌	The repository's name.
organization	string	❌	The organization that owns the repository.
schemaFolder	string	❌	The API definition's repository folder location.
collectionFolder	string	❌	The API definition's collection repository folder location.

GetApi2Schemas

Information about the schema.

Properties

Name	Type	Required	Description
id	string	❌	The schema's ID.

GetApi2Versions

Information about the version.

Properties

Name	Type	Required	Description
id	string	❌	The version's ID.
name	string	❌	The version's name.

GetApi2Collections

Information about the collection.

Properties

Name	Type	Required	Description
id	string	❌	The collection's ID.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →