Add and format descriptions
GET https://api.getpostman.com/workspaces?apikey={{postmanAPIKey}}
Provide a [description] for each parameter, request, folder, and collection. Style your descriptions, add tables, and embed screenshots [using Markdown] so readers can quickly identify the most relevant details. You will author the content inside Qodex in Markdown, but consumers will view it in the web browser as HTML.
Example table | Important headers |
---|---|
First thing to know | Supporting links |
Second thing to know | 👋 lookit me here! |
Check out the query parameter for this request. If I don't know where to get my Qodex API key, I can read the parameter description, and follow the hyperlink.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
apikey | string | You can get your key from the integrations dashboard. |