{"openapi":"3.1.0","info":{"title":"GET /api/v1/users","version":"1.0.0","description":"List users"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/users":{"get":{"tags":["user"],"summary":"List users","description":"List users with optional filtering. Pass x-business-id header or business_id for business-scoped view; firm_id for firm-wide view.","operationId":"list_users_api_v1_users_get","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search users by name or email","title":"Search"},"description":"Search users by name or email"},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by user UUID","title":"Id"},"description":"Filter by user UUID"},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by exact email address","title":"Email"},"description":"Filter by exact email address"},{"name":"business_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by business UUID. Returns users in that business only.","title":"Business Id"},"description":"Filter by business UUID. Returns users in that business only."},{"name":"firm_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by advisory firm UUID. Firm-wide: all users in that firm.","title":"Firm Id"},"description":"Filter by advisory firm UUID. Firm-wide: all users in that firm."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"},"description":"Cursor for pagination"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Pagination limit","title":"Limit"},"description":"Pagination limit"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Pagination direction: 'next' or 'prev'","default":"next","title":"Direction"},"description":"Pagination direction: 'next' or 'prev'"},{"name":"include_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count (expensive - avoid if possible)","default":false,"title":"Include Total Count"},"description":"Whether to include total count (expensive - avoid if possible)"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.","title":"Sort By"},"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None."},{"name":"descending","in":"query","required":false,"schema":{"type":"boolean","description":"Sort direction: true for descending (newest/largest first), false for ascending","default":true,"title":"Descending"},"description":"Sort direction: true for descending (newest/largest first), false for ascending"},{"name":"x-firm-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Advisory firm UUID for firm-wide view. Same as firm_id query param.","title":"X-Firm-Id"},"description":"Advisory firm UUID for firm-wide view. Same as firm_id query param."},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Business UUID for business-scoped view. Same as business_id query param.","title":"X-Business-Id"},"description":"Business UUID for business-scoped view. Same as business_id query param."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCursorListResponse"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Role":{"type":"string","enum":["owner","admin","member","viewer","accountant"],"title":"Role","description":"User roles in a business.\n\nSee ROLE_ABILITIES_DOC in app.models.user_businesses for detailed role descriptions.\nValid roles: owner, admin, member, viewer, accountant (legacy)."},"UserCursorListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","title":"Items","description":"List of items"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total number of items (null when not calculated for performance)"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"Pagination limit"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Cursor for next page"},"prev_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cursor","description":"Cursor for previous page"},"has_next":{"type":"boolean","title":"Has Next","description":"Whether there are more items"},"has_prev":{"type":"boolean","title":"Has Prev","description":"Whether there are previous items"}},"type":"object","required":["items","has_next","has_prev"],"title":"UserCursorListResponse","description":"Paginated list of users with cursor-based navigation."},"UserResponse":{"properties":{"email":{"type":"string","format":"email","title":"Email","description":"User email address (unique identifier)."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"User's first name."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"User's last name."},"photo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo Url","description":"URL to user's profile photo."},"onboarded":{"type":"boolean","title":"Onboarded","description":"Whether user has completed onboarding.","default":false},"props":{"additionalProperties":true,"type":"object","title":"Props","description":"Additional user properties/settings."},"id":{"type":"string","title":"Id","description":"User UUID."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Account creation timestamp."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Last profile update timestamp."},"firm_ids":{"items":{"type":"string"},"type":"array","title":"Firm Ids","description":"Advisory firm UUIDs the user belongs to."},"role":{"anyOf":[{"$ref":"#/components/schemas/Role"},{"type":"null"}],"description":"User's role in a business (only included when filtering by business_id)."}},"type":"object","required":["email","id","created_at","updated_at"],"title":"UserResponse","description":"Response schema for a user.\n\nContains user profile information and firm associations.","example":{"created_at":"2024-01-10T10:30:00Z","email":"john.doe@example.com","firm_ids":[],"first_name":"John","id":"019ab37c-user-7000-8000-000000000001","last_name":"Doe","onboarded":true,"photo_url":"https://example.com/photos/john.jpg","props":{"timezone":"America/Los_Angeles"},"updated_at":"2024-01-15T14:00:00Z"}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}