{"id":19587564,"url":"https://github.com/mcgalcode/listaroo","last_synced_at":"2026-06-13T11:33:25.847Z","repository":{"id":159573057,"uuid":"59954462","full_name":"mcgalcode/listaroo","owner":"mcgalcode","description":null,"archived":false,"fork":false,"pushed_at":"2016-07-12T20:01:13.000Z","size":49,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-26T13:14:30.347Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mcgalcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-29T17:01:32.000Z","updated_at":"2016-05-29T17:05:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"51b8f4c7-6f39-43c3-b8a3-ee1eba374596","html_url":"https://github.com/mcgalcode/listaroo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mcgalcode/listaroo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcgalcode%2Flistaroo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcgalcode%2Flistaroo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcgalcode%2Flistaroo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcgalcode%2Flistaroo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcgalcode","download_url":"https://codeload.github.com/mcgalcode/listaroo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcgalcode%2Flistaroo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34283390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T08:05:23.664Z","updated_at":"2026-06-13T11:33:25.738Z","avatar_url":"https://github.com/mcgalcode.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Listaroo Header Documentation\n\nTo make API requests to Listaroo resources (teams and lists), you must supply two additional headers in all HTTP requests:\n\n```\nuseridaroo: idOfLoggedInuser\nautharoo-token: apiTokenReturnedByLoginRequest\n```\n\n## Lists\n\nEach of the following endpoints returns either an array of list objects (for the Index endpoint) or a single list objects. List objects have the following parameters:\n\n* title\n* id\n* child_lists (an array of child lists, note that these children do NOT include their own children)\n\n### Index (get all lists for a team)\n\n```\nMethod: GET\nUrl: /api/lists.json?teamId=XXX (XXX is the id of the team whose list you want)\n```\n\n### Destroy\n\n```\nMethod: DELETE\nUrl: /api/lists/:list_id (where :list_id is the id of the list you want to delete)\n```\n\n### Create\n\n```\nMethod: POST\nUrl: /api/lists\nData:\n  {\n    \"title\" : yourListTitle,\n    \"teamId\" : teamId,\n    \"parentListId\" : parentListId    \n  }\n```\n\n**NOTE:** If you want to add a top level list to a team (list without a parent), pass a parentListId of 0.\n### Update\n\n```\nMethod: PUT\nUrl: /api/lists/:list_id (where :list_id is the id of the list to update)\nData:\n  {\n      'title': yourListTitle\n  }\n```\n\n### Show (get a particular list)\n\n```\nMethod: GET\nUrl: /api/lists/:list_id (where :list_id is the id of the desired list)\n```\n## Sessions\n\n### Create (login)*\n\n```\nMethod: POST\nUrl: /api/login\nData:\n  {\n    'username' : yourUserName,\n    'password' : yourPassword\n  }\n```\nReturns a user object with the following params:\n\n* id\n* first_name\n* last_name\n* username\n* email\n* api_token\n\n### Destroy (logout)\n\n```\nMethod: DELETE\nUrl: /api/:user_id/logout (where :user_id is the id you are logging out from)\n```\n\nReturns nothing.\n\n## Users\n\n### Create (Sign up)\n\n```\nMethod: POST\nUrl: /api/signup\nData:\n  {\n    \"username\" : \"blahblahblah\",\n    \"password\" : \"blahblahblah\",\n    \"password_confirmation\" : \"blahblahblah\",\n    \"first_name\" : \"blahblahblah\",\n    \"last_name\" : \"blahblahblah\",\n    \"email\" : \"blahblahblah\"\n  }\n```\nReturns a user object with the following properties:\n\n* id\n* first_name\n* last_name\n* username\n* email\n* api_token\n\n**NOTE:** If some of these properties are null on return, its because the server side has not been fully implemented yet, probably not your fault. (you should definitely get username, id and api_token tho)\n\n## Teams\n\nSome of the following methods return a json rendering of a team object with the following properties:\n\n* name\n* id\n* creator - a subobject with a .username property (i.e. response.data.creator.username)\n* invited_users - an array of subobjects, each with a .username property (i.e. response.data.invited_users[3].username)\n\n### Index\n\n```\nMethod: POST\nUrl: /api/teams?userId=XXX\u0026type=YYY\n  where:\n      userId is the name of the user\n      type: either \"created\" or \"invited\"\n```\n\nReturns either the teams the users have *created* or *invited* depending on the type parameter past in through the URL query string (team object in response has same structure described above)\n\n### Show\n\n```\nMethod: GET\nUrl: /api/teams/:team_id (where :team_id is the id of the team you wish to retrieve)\n```\n\nReturns a team object.\n\n### Create\n\n```\nMethod: POST\nUrl: /api/teams\nData:\n  {\n    'name' : yourNewTeamName,\n    'creatorId' : the id of the user who created the team\n  }\n```\n\nReturns a team object.\n\n### Destroy\n\n```\nMethod: DELETE\nUrl: /api/teams/:team_id (where :team_id is the id of the team you want to delete)\n```\n\nReturns nothing.\n\n### Update\n\n```\nMethod: PUT\nUrl: /api/teams/:team_id\nData:\n  {\n    'name' : revisedTeamName\n  }\n```\n\nReturns updated team object\n\n### Invite User\n\n```\nMethod: POST\nUrl: /api/teams/:team_id/invite (where :team_id is the id of the team you are inviting the user to)\ndata:\n  {\n    'username' : theUsernameOfTheInvitedUser\n  }\n```\n\nReturns the users username if successfully added.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcgalcode%2Flistaroo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcgalcode%2Flistaroo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcgalcode%2Flistaroo/lists"}