{"swagger":"2.0","host":"pro.coinmarketcap.com","basePath":"/","schemes":["http"],"info":{"title":"CoinMarketCap API - User Portal Documentation","version":"1.0.0","description":"Check out the **[Github Wiki](https://github.com/jedireza/frame/wiki)** for common questions and how-tos.\n\nA few key things to be aware of:\nThe core User model found in the /api/users/ endpoints have these basic fields: _id, email, username, password, isActive, roles, timeCreated.\n\nAll users no matter if it's an API Account, Website Account, or CMC Admin gets a basic User created. When users sign up via /api/signup the framework automatically creates this new User and then a new Product Account role for the user and links the two. Users can have multiple Account roles but each new instance of a role model can only be mapped to one user.\nThe API Account role adds these additional fields for users who are customers: \"name\" (first, middle last), \"notes\", and \"status\". \"Notes\" allows admins to add notes to accounts.\n\n/api/admins/ is the \"admin\" role.\nThis role contains a \"name\" (first, middle, last), \"permissions\", and \"groups\" property allowing you to assign multiple admin-groups. The first admin-group is \"root\" which is allowed to perform the \"Root Scope\" actions.\n\nMore details on [Users, Roles & Groups](https://github.com/jedireza/frame/wiki/Users,-Roles-&-Groups)\nMore details on [Admin & Admin Group Permissions](https://github.com/jedireza/frame/wiki/Admin-&-Admin-Group-Permissions)"},"tags":[{"name":"API Account","description":"endpoints to interact with API accounts."},{"name":"Web Account","description":"endpoints to interact with Web accounts."},{"name":"admin-groups","description":"endpoints to interact with admin groups."},{"name":"admins","description":"endpoints to interact with admin roles."},{"name":"contact"},{"name":"login","description":"endpoints for login flow."},{"name":"logout"},{"name":"main"},{"name":"session","description":"endpoints to interact with user sessions."},{"name":"signup"},{"name":"statuses","description":"endpoints to interact with API Product Account role statuses."},{"name":"users","description":"endpoints to interact with base users (outside of roles)"}],"paths":{"/healthcheck":{"get":{"summary":"Simple heartbeat response for Load Balencer checks","operationId":"getHealthcheck","description":"For load balancer.","tags":["heartbeat"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/api/heartbeat":{"get":{"summary":"Simple heartbeat response for Load Balencer checks","operationId":"getApiHeartbeat","description":"For load balancer.","tags":["heartbeat"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}}},"definitions":{}}