Postman API
  1. API
Postman API
  • API
    • Get all APIs
      GET
    • Create API
      POST
    • Delete an API
      DELETE
    • Single API
      GET
    • Update an API
      PUT
    • Get All API Versions
      GET
    • Create API Version
      POST
    • Delete an API Version
      DELETE
    • Get an API Version
      GET
    • Update an API Version
      PUT
    • Get contract test relations
      GET
    • Get documentation relations
      GET
    • Get environment relations
      GET
    • Get integration test relations
      GET
    • Get monitor relations
      GET
    • Get linked relations
      GET
    • Create relations
      POST
    • Create Schema
      POST
    • Get Schema
      GET
    • Update Schema
      PUT
    • Create collection from schema
      POST
    • Get test suite relations
      GET
    • Sync relations with schema
      PUT
  • Collections
    • All Collections
      GET
    • Create Collection
      POST
    • Create a Fork
      POST
    • Merge a Fork
      POST
    • Delete Collection
      DELETE
    • Single Collection
      GET
    • Update Collection
      PUT
  • Environments
    • All Environments
    • Create Environment
    • Delete Environment
    • Single Environment
    • Update Environment
  • Import
    • Import exported data
    • Import external API specification
  • User
    • API Key Owner
  • Mocks
    • All Mocks
    • Create Mock
    • Delete Mock
    • Single Mock
    • Update Mock
    • Publish Mock
    • Unpublish Mock
  • Monitors
    • All Monitors
    • Create Monitor
    • Delete Monitor
    • Single Monitor
    • Update Monitor
    • Run a Monitor
  • Webhooks
    • Create Webhook
  • Workspaces
    • All workspaces
    • Create Workspace
    • Delete Workspace
    • Single workspace
    • Update Workspace
  1. API

Get test suite relations

GET
/apis/{apiId}/versions/{apiVersionId}/testsuite
APIRelations
This call fetches all the relations by type which are linked to the specified API version along with their details.
The response will contain an array with key {{relationType}}. Each of the item will consist of all the details related each of the relation.
Requires API Key as X-Api-Key request header or apikey URL query parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.getpostman.com/apis//versions//testsuite'
Response Response Example
{
  "testsuite": [
    {
      "collectionId": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745",
      "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2",
      "name": "C test",
      "updatedAt": "2019-08-29T10:18:11.000Z"
    },
    {
      "collectionId": "7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725",
      "id": "521b0486-ab91-4d3a-9189-43c9380a0533",
      "name": "C1",
      "updatedAt": "2019-08-29T11:40:39.000Z"
    }
  ]
}

Request

Path Params
apiId
string 
required
apiVersionId
string 
required

Responses

🟢200Get test suite relations
application/json
Body
testsuite
array [object {4}] 
optional
collectionId
string 
optional
Example:
7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745
id
string 
optional
Example:
2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2
name
string 
optional
Example:
C test
updatedAt
string 
optional
Example:
2019-08-29T10:18:11.000Z
Previous
Create collection from schema
Next
Sync relations with schema
Built with