api get
HTTP GET against Platform api session
Issue an HTTP GET using the Platform: api session ($API_BASE_URL + path).
Syntax
When I api get "<path>"Requirements
| Item | Contract |
|---|---|
| Element / control shape | None — HTTP session (Platform: api) |
| How the label binds | Path / body / headers are payloads ($ENV, slots expand) |
| Qualifiers that change resolve | See this command’s Qualifiers table |
| Platform | Platform: api only — requires $API_BASE_URL (and auth env as needed) |
| Wrong shape → use instead | UI XHR wait → wait for response. Browser UI → web commands |
See also UI contracts and Platform: api.
Examples
Platform: api
Scenario: List orders
When I api get "/orders"
Then I api should status "200"Notes
- Relative paths join
$API_BASE_URL. Absolute URLs are also accepted by the session. - Quoted values expand via shared resolve (
$ENV,@/@@whole-string slots,{{faker}}). - Requires Platform: api.