Postman Collection

The Ozzie Postman collection includes every API endpoint with pre-filled example requests and responses. It's organized in the same sequence as the recommended integration flow, so you can run through a complete user onboarding, plan generation, and chat session without writing any code.

---

Download

Download the Postman collection

The collection is a standard Postman v2.1 JSON file. It includes all endpoints as of the current API version.

---

Importing into Postman

1. Open Postman
2. Click Import in the top-left corner
3. Select File and choose the downloaded ozzie-api.postman_collection.json
4. Click Import

The collection will appear in your left sidebar under Collections as Ozzie API.

Alternatively, you can import directly from a URL:

1. Click Import
2. Select Link
3. Paste: https://api.ozzieapp.com/postman/ozzie-api.postman_collection.json
4. Click Continue, then Import

tip

After importing, also import the companion Ozzie API Environment to pre-configure all variables. Download it at: https://api.ozzieapp.com/postman/ozzie-api.postman_environment.json

---

Setting up environment variables

The collection uses three environment variables that you must configure before making requests:

Variable	Description	Example value
BASE_URL	The Ozzie API base URL	https://api.ozzieapp.com/v1
TOKEN	Your base64-encoded client_id:client_secret	ozp_Y2xpZW50X2ExYjJjM2Q0...
USER_ID	The Ozzie user ID to use in path parameters	usr_4f8a1b2c3d

How to set them

1. Click the Environment dropdown in the top-right corner of Postman
2. Select Ozzie API (or No Environment → Add)
3. Fill in the three variables above
4. Click Save

To generate your TOKEN value, base64-encode your client_id:client_secret:

echo -n "ozz_client_a1b2c3d4:sk_live_xK9mP2qR7tL..." | base64

Paste the output as your TOKEN variable value.

info

You'll need to update USER_ID each time you want to test against a different user. The simplest workflow is to create a test user once via the POST /users request in the collection, copy the returned id, and paste it into USER_ID.

---

Collection structure

The collection is organized in the recommended API flow sequence:

Ozzie API
├── 1. Users
│   ├── Create user (POST /users)
│   └── Get user (GET /users/{user_id})
├── 2. Financial Intake
│   ├── Submit intake (POST /users/{user_id}/financial-intake)
│   └── Get intake (GET /users/{user_id}/financial-intake)
├── 3. Transactions
│   ├── Submit text transaction
│   ├── Submit image transaction
│   └── List transactions
├── 4. Goals
│   ├── Set goal (POST /users/{user_id}/goals)
│   └── Get goal (GET /users/{user_id}/goals)
├── 5. Plan
│   ├── Generate plan (POST /users/{user_id}/plan)
│   └── Personalize plan (POST /users/{user_id}/plan/personalize)
├── 6. Money Moves
│   ├── Generate cycle (POST /users/{user_id}/money-moves/generate)
│   ├── List cycles (GET /users/{user_id}/money-moves)
│   ├── Get cycle (GET /users/{user_id}/money-moves/{move_id})
│   └── Update cycle status (PATCH /users/{user_id}/money-moves/{move_id})
└── 7. Chat
    └── Send message (POST /users/{user_id}/chat/messages)

Each request includes:

• A pre-filled example request body with realistic values
• Pre-request scripts that automatically update USER_ID from previous responses (in the onboarding sequence)
• Test scripts that validate the response shape and status code

---

Running the full collection

Use Postman's Collection Runner to execute all requests in sequence — simulating a complete user onboarding and interaction:

1. Right-click the Ozzie API collection in the sidebar
2. Click Run collection
3. Set Iterations to 1
4. Check Save responses
5. Click Run Ozzie API

The runner will execute every request in order. The pre-request and test scripts handle extracting IDs from responses and passing them to subsequent requests automatically.

tip

Use the Collection Runner to smoke-test your integration after updating your credentials or moving to a new environment. If all requests pass their test scripts, your setup is healthy.

---

Screenshot

Add a screenshot of the Postman collection sidebar here showing the folder structure.

---

Automated testing

The collection's test scripts can be run in CI/CD using Newman, Postman's command-line runner:

# Install Newman
npm install -g newman

# Run the collection
newman run ozzie-api.postman_collection.json \
  --environment ozzie-api.postman_environment.json \
  --reporters cli,junit \
  --reporter-junit-export results.xml

This outputs a JUnit-compatible XML file you can attach to your CI pipeline (GitHub Actions, Jenkins, GitLab CI, etc.) for pass/fail reporting.

# Example: GitHub Actions step
- name: Run Ozzie API tests
  run: |
    newman run ozzie-api.postman_collection.json \
      --environment ozzie-api.postman_environment.json \
      --reporters cli,junit \
      --reporter-junit-export test-results.xml
  env:
    OZZIE_TOKEN: ${{ secrets.OZZIE_TOKEN }}