Get Collection

GET {{baseUrl}}/collections/{{collectionUID}}

This request gets a Qodex collection with the given collectionUID, using the x-api-key from the environment.

This request auto-generates environment variables in the format {{Repository Name}}/{{Branch Name}}/collectionContent and in the format {{Repository Name}}/{{Branch Name}}/collectionDeleted. See the Note underneath Environment Setup for more details.

This request also uses the variable baseCollection as part of the request URL to retrieve the collection. The baseCollection variable allows the switching of this request from a regular GET request (which would use https://api.getQodex.com) to an example generated through the Mock Server (which would use the Mock Server URL).

HEADERS

RESPONSES

status: OK

{"collection":{"info":{"_postman_id":"0a00a0a0-0a00-0a00-000a-a00a0a0000aa","name":"The Best Collection","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"New Request","id":"a00aaaaa-a0a0-0aa0-000a-aa0aa0a00a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":null},"response":[]}]}}