{"id":21553118,"url":"https://github.com/flatio/api-client-js","last_synced_at":"2025-07-14T20:41:26.415Z","repository":{"id":19721987,"uuid":"87728525","full_name":"FlatIO/api-client-js","owner":"FlatIO","description":"💛 JavaScript client for the Flat REST API","archived":false,"fork":false,"pushed_at":"2024-05-16T01:07:42.000Z","size":711,"stargazers_count":11,"open_issues_count":5,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-10T12:02:05.723Z","etag":null,"topics":["api-client","bower","education","flat-api","javascript","midi","music-notation","musicxml","nodejs","score"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FlatIO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2017-04-09T18:05:19.000Z","updated_at":"2024-01-26T00:02:45.000Z","dependencies_parsed_at":"2025-04-10T07:50:25.227Z","dependency_job_id":"ce8bc8ba-8bd2-4d0b-85b7-8778050bf6a4","html_url":"https://github.com/FlatIO/api-client-js","commit_stats":{"total_commits":58,"total_committers":4,"mean_commits":14.5,"dds":0.5344827586206897,"last_synced_commit":"7b7ca583c6dd2354761338925e8b1f3e2a1c6ecd"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/FlatIO/api-client-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlatIO","download_url":"https://codeload.github.com/FlatIO/api-client-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265345225,"owners_count":23750571,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api-client","bower","education","flat-api","javascript","midi","music-notation","musicxml","nodejs","score"],"created_at":"2024-11-24T07:09:34.494Z","updated_at":"2025-07-14T20:41:26.375Z","avatar_url":"https://github.com/FlatIO.png","language":"JavaScript","readme":"# JavaScript (Browser \u0026 Node.js) Client for the Flat REST API\n\n[![Build Status](https://img.shields.io/travis/FlatIO/api-client-js.svg?style=flat)](https://travis-ci.org/FlatIO/api-client-js)\n[![NPM Version](https://img.shields.io/npm/v/flat-api.svg?style=flat)](https://www.npmjs.org/package/flat-api)\n\nThe Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:\n- Creating and importing new music scores using MusicXML or MIDI files\n- Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI)\n- Managing educational resources with Flat for Education: creating \u0026 updating the organization accounts, the classes, rosters and assignments.\n\nYou can find the API reference including code samples and our OpenAPI Specification at the following url: [https://flat.io/developers/api/reference](https://flat.io/developers/api/reference).\n\nTo request some API credentials, please visit [https://flat.io/developers](https://flat.io/developers).\n\nThis JavaScript package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\n```shell\n$ npm install flat-api --save\n```\n\n#### git\n\n```shell\n$ npm install git://github.com/FlatIO/api-client-js --save\n```\n\n### For browser\n\n### bower\n\n```shell\n$ bower install flat-api\n```\n\n### git / github\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/).\nA build is available in the `build` directory, you can also rebuild the library:\n\n```shell\n$ npm install -d \u0026\u0026 npm run build\n$ ls -1 build\nflat-api.js\nflat-api.js.map\nflat-api.min.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar FlatApi = require('flat-api');\n\n// Configure OAuth2 access token for authorization\nFlatApi.ApiClient.instance.authentications.OAuth2.accessToken = 'YOUR_ACCES_TOKEN';\n\nvar flatAccountApi = new FlatApi.AccountApi();\nflatAccountApi.getAuthenticatedUser(function(error, data, response) {\n  if (error) {\n    console.error(error);\n  }\n  else {\n    console.log('Successfully retrieved user profile: ', data);\n  }\n});\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.flat.io/v2*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FlatApi.AccountApi* | [**getAuthenticatedUser**](docs/AccountApi.md#getAuthenticatedUser) | **GET** /me | Get current user profile\n*FlatApi.ClassApi* | [**activateClass**](docs/ClassApi.md#activateClass) | **POST** /classes/{class}/activate | Activate the class\n*FlatApi.ClassApi* | [**addClassUser**](docs/ClassApi.md#addClassUser) | **PUT** /classes/{class}/users/{user} | Add a user to the class\n*FlatApi.ClassApi* | [**archiveClass**](docs/ClassApi.md#archiveClass) | **POST** /classes/{class}/archive | Archive the class\n*FlatApi.ClassApi* | [**copyAssignment**](docs/ClassApi.md#copyAssignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment\n*FlatApi.ClassApi* | [**createAssignment**](docs/ClassApi.md#createAssignment) | **POST** /classes/{class}/assignments | Assignment creation\n*FlatApi.ClassApi* | [**createClass**](docs/ClassApi.md#createClass) | **POST** /classes | Create a new class\n*FlatApi.ClassApi* | [**createSubmission**](docs/ClassApi.md#createSubmission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission\n*FlatApi.ClassApi* | [**deleteClassUser**](docs/ClassApi.md#deleteClassUser) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class\n*FlatApi.ClassApi* | [**editSubmission**](docs/ClassApi.md#editSubmission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission\n*FlatApi.ClassApi* | [**enrollClass**](docs/ClassApi.md#enrollClass) | **POST** /classes/enroll/{enrollmentCode} | Join a class\n*FlatApi.ClassApi* | [**getClass**](docs/ClassApi.md#getClass) | **GET** /classes/{class} | Get the details of a single class\n*FlatApi.ClassApi* | [**getScoreSubmissions**](docs/ClassApi.md#getScoreSubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score\n*FlatApi.ClassApi* | [**getSubmission**](docs/ClassApi.md#getSubmission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission\n*FlatApi.ClassApi* | [**getSubmissions**](docs/ClassApi.md#getSubmissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students\u0026#39; submissions\n*FlatApi.ClassApi* | [**listAssignments**](docs/ClassApi.md#listAssignments) | **GET** /classes/{class}/assignments | Assignments listing\n*FlatApi.ClassApi* | [**listClassStudentSubmissions**](docs/ClassApi.md#listClassStudentSubmissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student\n*FlatApi.ClassApi* | [**listClasses**](docs/ClassApi.md#listClasses) | **GET** /classes | List the classes available for the current user\n*FlatApi.ClassApi* | [**unarchiveClass**](docs/ClassApi.md#unarchiveClass) | **DELETE** /classes/{class}/archive | Unarchive the class\n*FlatApi.ClassApi* | [**updateClass**](docs/ClassApi.md#updateClass) | **PUT** /classes/{class} | Update the class\n*FlatApi.CollectionApi* | [**addScoreToCollection**](docs/CollectionApi.md#addScoreToCollection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection\n*FlatApi.CollectionApi* | [**createCollection**](docs/CollectionApi.md#createCollection) | **POST** /collections | Create a new collection\n*FlatApi.CollectionApi* | [**deleteCollection**](docs/CollectionApi.md#deleteCollection) | **DELETE** /collections/{collection} | Delete the collection\n*FlatApi.CollectionApi* | [**deleteScoreFromCollection**](docs/CollectionApi.md#deleteScoreFromCollection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection\n*FlatApi.CollectionApi* | [**editCollection**](docs/CollectionApi.md#editCollection) | **PUT** /collections/{collection} | Update a collection\u0026#39;s metadata\n*FlatApi.CollectionApi* | [**getCollection**](docs/CollectionApi.md#getCollection) | **GET** /collections/{collection} | Get collection details\n*FlatApi.CollectionApi* | [**listCollectionScores**](docs/CollectionApi.md#listCollectionScores) | **GET** /collections/{collection}/scores | List the scores contained in a collection\n*FlatApi.CollectionApi* | [**listCollections**](docs/CollectionApi.md#listCollections) | **GET** /collections | List the collections\n*FlatApi.CollectionApi* | [**untrashCollection**](docs/CollectionApi.md#untrashCollection) | **POST** /collections/{collection}/untrash | Untrash a collection\n*FlatApi.GroupApi* | [**getGroupDetails**](docs/GroupApi.md#getGroupDetails) | **GET** /groups/{group} | Get group information\n*FlatApi.GroupApi* | [**getGroupScores**](docs/GroupApi.md#getGroupScores) | **GET** /groups/{group}/scores | List group\u0026#39;s scores\n*FlatApi.GroupApi* | [**listGroupUsers**](docs/GroupApi.md#listGroupUsers) | **GET** /groups/{group}/users | List group\u0026#39;s users\n*FlatApi.OrganizationApi* | [**createLtiCredentials**](docs/OrganizationApi.md#createLtiCredentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials\n*FlatApi.OrganizationApi* | [**createOrganizationInvitation**](docs/OrganizationApi.md#createOrganizationInvitation) | **POST** /organizations/invitations | Create a new invitation to join the organization\n*FlatApi.OrganizationApi* | [**createOrganizationUser**](docs/OrganizationApi.md#createOrganizationUser) | **POST** /organizations/users | Create a new user account\n*FlatApi.OrganizationApi* | [**listLtiCredentials**](docs/OrganizationApi.md#listLtiCredentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials\n*FlatApi.OrganizationApi* | [**listOrganizationInvitations**](docs/OrganizationApi.md#listOrganizationInvitations) | **GET** /organizations/invitations | List the organization invitations\n*FlatApi.OrganizationApi* | [**listOrganizationUsers**](docs/OrganizationApi.md#listOrganizationUsers) | **GET** /organizations/users | List the organization users\n*FlatApi.OrganizationApi* | [**removeOrganizationInvitation**](docs/OrganizationApi.md#removeOrganizationInvitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation\n*FlatApi.OrganizationApi* | [**removeOrganizationUser**](docs/OrganizationApi.md#removeOrganizationUser) | **DELETE** /organizations/users/{user} | Remove an account from Flat\n*FlatApi.OrganizationApi* | [**revokeLtiCredentials**](docs/OrganizationApi.md#revokeLtiCredentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials\n*FlatApi.OrganizationApi* | [**updateOrganizationUser**](docs/OrganizationApi.md#updateOrganizationUser) | **PUT** /organizations/users/{user} | Update account information\n*FlatApi.ScoreApi* | [**addScoreCollaborator**](docs/ScoreApi.md#addScoreCollaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator\n*FlatApi.ScoreApi* | [**addScoreTrack**](docs/ScoreApi.md#addScoreTrack) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score\n*FlatApi.ScoreApi* | [**createScore**](docs/ScoreApi.md#createScore) | **POST** /scores | Create a new score\n*FlatApi.ScoreApi* | [**createScoreRevision**](docs/ScoreApi.md#createScoreRevision) | **POST** /scores/{score}/revisions | Create a new revision\n*FlatApi.ScoreApi* | [**deleteScore**](docs/ScoreApi.md#deleteScore) | **DELETE** /scores/{score} | Delete a score\n*FlatApi.ScoreApi* | [**deleteScoreComment**](docs/ScoreApi.md#deleteScoreComment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment\n*FlatApi.ScoreApi* | [**deleteScoreTrack**](docs/ScoreApi.md#deleteScoreTrack) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score\n*FlatApi.ScoreApi* | [**editScore**](docs/ScoreApi.md#editScore) | **PUT** /scores/{score} | Edit a score\u0026#39;s metadata\n*FlatApi.ScoreApi* | [**forkScore**](docs/ScoreApi.md#forkScore) | **POST** /scores/{score}/fork | Fork a score\n*FlatApi.ScoreApi* | [**gerUserLikes**](docs/ScoreApi.md#gerUserLikes) | **GET** /users/{user}/likes | List liked scores\n*FlatApi.ScoreApi* | [**getGroupScores**](docs/ScoreApi.md#getGroupScores) | **GET** /groups/{group}/scores | List group\u0026#39;s scores\n*FlatApi.ScoreApi* | [**getScore**](docs/ScoreApi.md#getScore) | **GET** /scores/{score} | Get a score\u0026#39;s metadata\n*FlatApi.ScoreApi* | [**getScoreCollaborator**](docs/ScoreApi.md#getScoreCollaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator\n*FlatApi.ScoreApi* | [**getScoreCollaborators**](docs/ScoreApi.md#getScoreCollaborators) | **GET** /scores/{score}/collaborators | List the collaborators\n*FlatApi.ScoreApi* | [**getScoreComments**](docs/ScoreApi.md#getScoreComments) | **GET** /scores/{score}/comments | List comments\n*FlatApi.ScoreApi* | [**getScoreRevision**](docs/ScoreApi.md#getScoreRevision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision\n*FlatApi.ScoreApi* | [**getScoreRevisionData**](docs/ScoreApi.md#getScoreRevisionData) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data\n*FlatApi.ScoreApi* | [**getScoreRevisions**](docs/ScoreApi.md#getScoreRevisions) | **GET** /scores/{score}/revisions | List the revisions\n*FlatApi.ScoreApi* | [**getScoreSubmissions**](docs/ScoreApi.md#getScoreSubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score\n*FlatApi.ScoreApi* | [**getScoreTrack**](docs/ScoreApi.md#getScoreTrack) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score\n*FlatApi.ScoreApi* | [**getUserScores**](docs/ScoreApi.md#getUserScores) | **GET** /users/{user}/scores | List user\u0026#39;s scores\n*FlatApi.ScoreApi* | [**listScoreTracks**](docs/ScoreApi.md#listScoreTracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score\n*FlatApi.ScoreApi* | [**markScoreCommentResolved**](docs/ScoreApi.md#markScoreCommentResolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved\n*FlatApi.ScoreApi* | [**markScoreCommentUnresolved**](docs/ScoreApi.md#markScoreCommentUnresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved\n*FlatApi.ScoreApi* | [**postScoreComment**](docs/ScoreApi.md#postScoreComment) | **POST** /scores/{score}/comments | Post a new comment\n*FlatApi.ScoreApi* | [**removeScoreCollaborator**](docs/ScoreApi.md#removeScoreCollaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator\n*FlatApi.ScoreApi* | [**untrashScore**](docs/ScoreApi.md#untrashScore) | **POST** /scores/{score}/untrash | Untrash a score\n*FlatApi.ScoreApi* | [**updateScoreComment**](docs/ScoreApi.md#updateScoreComment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment\n*FlatApi.ScoreApi* | [**updateScoreTrack**](docs/ScoreApi.md#updateScoreTrack) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score\n*FlatApi.UserApi* | [**gerUserLikes**](docs/UserApi.md#gerUserLikes) | **GET** /users/{user}/likes | List liked scores\n*FlatApi.UserApi* | [**getUser**](docs/UserApi.md#getUser) | **GET** /users/{user} | Get a public user profile\n*FlatApi.UserApi* | [**getUserScores**](docs/UserApi.md#getUserScores) | **GET** /users/{user}/scores | List user\u0026#39;s scores\n\n\n## Documentation for Models\n\n - [FlatApi.Assignment](docs/Assignment.md)\n - [FlatApi.AssignmentCopy](docs/AssignmentCopy.md)\n - [FlatApi.AssignmentCreation](docs/AssignmentCreation.md)\n - [FlatApi.AssignmentSubmission](docs/AssignmentSubmission.md)\n - [FlatApi.AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)\n - [FlatApi.ClassAttachmentCreation](docs/ClassAttachmentCreation.md)\n - [FlatApi.ClassCreation](docs/ClassCreation.md)\n - [FlatApi.ClassDetails](docs/ClassDetails.md)\n - [FlatApi.ClassDetailsCanvas](docs/ClassDetailsCanvas.md)\n - [FlatApi.ClassDetailsClever](docs/ClassDetailsClever.md)\n - [FlatApi.ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)\n - [FlatApi.ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)\n - [FlatApi.ClassDetailsLti](docs/ClassDetailsLti.md)\n - [FlatApi.ClassRoles](docs/ClassRoles.md)\n - [FlatApi.ClassState](docs/ClassState.md)\n - [FlatApi.ClassUpdate](docs/ClassUpdate.md)\n - [FlatApi.Collection](docs/Collection.md)\n - [FlatApi.CollectionCapabilities](docs/CollectionCapabilities.md)\n - [FlatApi.CollectionCreation](docs/CollectionCreation.md)\n - [FlatApi.CollectionModification](docs/CollectionModification.md)\n - [FlatApi.CollectionPrivacy](docs/CollectionPrivacy.md)\n - [FlatApi.CollectionTitle](docs/CollectionTitle.md)\n - [FlatApi.CollectionType](docs/CollectionType.md)\n - [FlatApi.FlatErrorResponse](docs/FlatErrorResponse.md)\n - [FlatApi.FlatLocales](docs/FlatLocales.md)\n - [FlatApi.GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)\n - [FlatApi.GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)\n - [FlatApi.Group](docs/Group.md)\n - [FlatApi.GroupDetails](docs/GroupDetails.md)\n - [FlatApi.GroupType](docs/GroupType.md)\n - [FlatApi.LicenseMode](docs/LicenseMode.md)\n - [FlatApi.LicenseSources](docs/LicenseSources.md)\n - [FlatApi.LmsName](docs/LmsName.md)\n - [FlatApi.LtiCredentials](docs/LtiCredentials.md)\n - [FlatApi.LtiCredentialsCreation](docs/LtiCredentialsCreation.md)\n - [FlatApi.MediaAttachment](docs/MediaAttachment.md)\n - [FlatApi.MediaScoreSharingMode](docs/MediaScoreSharingMode.md)\n - [FlatApi.OrganizationInvitation](docs/OrganizationInvitation.md)\n - [FlatApi.OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)\n - [FlatApi.OrganizationRoles](docs/OrganizationRoles.md)\n - [FlatApi.ResourceCollaboratorCreation](docs/ResourceCollaboratorCreation.md)\n - [FlatApi.ResourceRights](docs/ResourceRights.md)\n - [FlatApi.ResourceSharingKey](docs/ResourceSharingKey.md)\n - [FlatApi.ScoreComment](docs/ScoreComment.md)\n - [FlatApi.ScoreCommentContext](docs/ScoreCommentContext.md)\n - [FlatApi.ScoreCommentCreation](docs/ScoreCommentCreation.md)\n - [FlatApi.ScoreCommentUpdate](docs/ScoreCommentUpdate.md)\n - [FlatApi.ScoreCommentsCounts](docs/ScoreCommentsCounts.md)\n - [FlatApi.ScoreCreation](docs/ScoreCreation.md)\n - [FlatApi.ScoreCreationType](docs/ScoreCreationType.md)\n - [FlatApi.ScoreData](docs/ScoreData.md)\n - [FlatApi.ScoreDataEncoding](docs/ScoreDataEncoding.md)\n - [FlatApi.ScoreFork](docs/ScoreFork.md)\n - [FlatApi.ScoreLicense](docs/ScoreLicense.md)\n - [FlatApi.ScoreLikesCounts](docs/ScoreLikesCounts.md)\n - [FlatApi.ScoreModification](docs/ScoreModification.md)\n - [FlatApi.ScorePrivacy](docs/ScorePrivacy.md)\n - [FlatApi.ScoreRevision](docs/ScoreRevision.md)\n - [FlatApi.ScoreRevisionCreation](docs/ScoreRevisionCreation.md)\n - [FlatApi.ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md)\n - [FlatApi.ScoreSource](docs/ScoreSource.md)\n - [FlatApi.ScoreSummary](docs/ScoreSummary.md)\n - [FlatApi.ScoreTrack](docs/ScoreTrack.md)\n - [FlatApi.ScoreTrackCreation](docs/ScoreTrackCreation.md)\n - [FlatApi.ScoreTrackPoint](docs/ScoreTrackPoint.md)\n - [FlatApi.ScoreTrackState](docs/ScoreTrackState.md)\n - [FlatApi.ScoreTrackType](docs/ScoreTrackType.md)\n - [FlatApi.ScoreTrackUpdate](docs/ScoreTrackUpdate.md)\n - [FlatApi.ScoreViewsCounts](docs/ScoreViewsCounts.md)\n - [FlatApi.UserAdminUpdate](docs/UserAdminUpdate.md)\n - [FlatApi.UserBasics](docs/UserBasics.md)\n - [FlatApi.UserCreation](docs/UserCreation.md)\n - [FlatApi.UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)\n - [FlatApi.UserInstruments](docs/UserInstruments.md)\n - [FlatApi.ResourceCollaborator](docs/ResourceCollaborator.md)\n - [FlatApi.ScoreDetails](docs/ScoreDetails.md)\n - [FlatApi.UserPublicSummary](docs/UserPublicSummary.md)\n - [FlatApi.UserDetailsAdmin](docs/UserDetailsAdmin.md)\n - [FlatApi.UserPublic](docs/UserPublic.md)\n - [FlatApi.UserDetails](docs/UserDetails.md)\n\n\n## Documentation for Authorization\n\n\n### OAuth2\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: https://flat.io/auth/oauth\n- **Scopes**: \n  - account.public_profile: Provides access to the basic person\u0026#39;s public profile. Education profiles may be anonymized with this scope, you can request the scope \u0026#x60;education_profile\u0026#x60; to access to the a basic education account profile. \n  - account.education_profile: Provides access to the basic person\u0026#39;s education profile and public organization information. \n  - scores.readonly: Allows read-only access to all a user\u0026#39;s scores. You won\u0026#39;t need this scope to read public scores. \n  - scores.social: Allow to post comments and like scores \n  - scores: Full, permissive scope to access all of a user\u0026#39;s scores. \n  - collections.readonly: Allow read-only access to a user\u0026#39;s collections.\n  - collections.add_scores: Allow to add scores to a user\u0026#39;s collections.\n  - collections: Full, permissive scope to access all of a user\u0026#39;s collections.\n  - edu.classes: Full, permissive scope to manage the classes.\n  - edu.classes.readonly: Read-only access to the classes.\n  - edu.assignments: Read-write access to the assignments and submissions.\n  - edu.assignments.readonly: Read-only access to the assignments and submissions.\n  - edu.admin: Full, permissive scope to manage all the admin of an organization.\n  - edu.admin.lti: Access and manage the LTI Credentials for an organization.\n  - edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.\n  - edu.admin.users: Access and manage the users and invitations of the organization.\n  - edu.admin.users.readonly: Read-only access to the users and invitations of the organization.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatio%2Fapi-client-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflatio%2Fapi-client-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatio%2Fapi-client-js/lists"}