Request & Response Formats

Request Formats

  • JSON only:

    • Content-Type: application/json

    • Authorization: Bearer {token}

    • Idempotency-Key: {uuid4} (POST requests only)

  • Params:

    • Path: /api/v1/{resource}/:id

    • Query: ?status=active

  • Body:

    • camelCase fields matching components/schemas

    • ISO 8601 for dates (YYYY-MM-DDTHH:mm:ss.sssZ)

Response Formats

  • JSON with appropriate HTTP status:

    • 200 OK (GET/PUT/DELETE)

    • 201 Created (POST)

  • Payloads:

    • Single resource → object

    • Collections → array or named wrapper per spec