// HTTP method
GET
Retrieve a representation of the target resource without requesting a state change.
SafeIdempotent
Idempotency
Idempotent: repeating the same request should have the same intended effect as sending it once.
Common use cases
- Read one resource.
- List or search a resource collection.
- Retrieve a calculated representation without causing side effects.
Common mistakes
- Changing server state during a GET.
- Putting a required request body on GET.
- Omitting cache rules for sensitive or changing data.
Request
GET /payments/pay_123 HTTP/1.1
Accept: application/jsonResponse
HTTP/1.1 200 OK
Content-Type: application/json
{ "id": "pay_123", "status": "settled" }// GET STARTED
Design and test a GET operation.
Define the contract in API Designer, then execute it with Cloud Runner or Browser Runner.