{"id":21553119,"url":"https://github.com/flatio/api-client-php","last_synced_at":"2025-07-31T12:35:11.455Z","repository":{"id":52419524,"uuid":"87733149","full_name":"FlatIO/api-client-php","owner":"FlatIO","description":"🐘  PHP client for the Flat REST API","archived":false,"fork":false,"pushed_at":"2021-04-29T19:39:13.000Z","size":335,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-10T08:59:53.067Z","etag":null,"topics":["api-client","composer","education","flat-api","midi","music-notation","musicxml","php","php-client","score"],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/FlatIO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-09T19:19:39.000Z","updated_at":"2019-08-27T07:22:44.000Z","dependencies_parsed_at":"2022-09-13T19:31:10.614Z","dependency_job_id":null,"html_url":"https://github.com/FlatIO/api-client-php","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/FlatIO/api-client-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlatIO","download_url":"https://codeload.github.com/FlatIO/api-client-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-php/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268039934,"owners_count":24185827,"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","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"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":["api-client","composer","education","flat-api","midi","music-notation","musicxml","php","php-client","score"],"created_at":"2024-11-24T07:09:34.610Z","updated_at":"2025-07-31T12:35:11.431Z","avatar_url":"https://github.com/FlatIO.png","language":"PHP","readme":"# PHP Client for the Flat REST API\n\n[![Build Status](https://travis-ci.org/FlatIO/api-client-php.svg?branch=master)](https://travis-ci.org/FlatIO/api-client-php)\n[![Packagist](https://img.shields.io/packagist/v/flat/api.svg)](https://packagist.org/packages/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 Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.\n\n## Requirements\n\nPHP 5.6.0 and later\n\n## Installation \u0026 Usage\n### Composer\n\nTo install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:\n\n```\n{\n    \"name\": \"Example Application\",\n    \"description\": \"This is an example using the Flat API\",\n    \"require\": {\n        \"flat/api\": \"dev-master\"\n    }\n}\n\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\nrequire_once('/path/to/./vendor/autoload.php');\n```\n\n## Tests\n\nTo run the unit tests:\n\n```\ncomposer install\n./vendor/bin/phpunit\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n// Configure OAuth2 access token for authorization: OAuth2\n$config = Flat\\APIClient\\Configuration::getDefaultConfiguration()-\u003esetAccessToken('YOUR_ACCESS_TOKEN');\n\n$apiInstance = new Flat\\APIClient\\Api\\AccountApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n\ntry {\n    $result = $apiInstance-\u003egetAuthenticatedUser();\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling AccountApi-\u003egetAuthenticatedUser: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n?\u003e\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*AccountApi* | [**getAuthenticatedUser**](docs/Api/AccountApi.md#getauthenticateduser) | **GET** /me | Get current user profile\n*ClassApi* | [**activateClass**](docs/Api/ClassApi.md#activateclass) | **POST** /classes/{class}/activate | Activate the class\n*ClassApi* | [**addClassUser**](docs/Api/ClassApi.md#addclassuser) | **PUT** /classes/{class}/users/{user} | Add a user to the class\n*ClassApi* | [**archiveClass**](docs/Api/ClassApi.md#archiveclass) | **POST** /classes/{class}/archive | Archive the class\n*ClassApi* | [**copyAssignment**](docs/Api/ClassApi.md#copyassignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment\n*ClassApi* | [**createAssignment**](docs/Api/ClassApi.md#createassignment) | **POST** /classes/{class}/assignments | Assignment creation\n*ClassApi* | [**createClass**](docs/Api/ClassApi.md#createclass) | **POST** /classes | Create a new class\n*ClassApi* | [**createSubmission**](docs/Api/ClassApi.md#createsubmission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission\n*ClassApi* | [**deleteClassUser**](docs/Api/ClassApi.md#deleteclassuser) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class\n*ClassApi* | [**editSubmission**](docs/Api/ClassApi.md#editsubmission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission\n*ClassApi* | [**enrollClass**](docs/Api/ClassApi.md#enrollclass) | **POST** /classes/enroll/{enrollmentCode} | Join a class\n*ClassApi* | [**getClass**](docs/Api/ClassApi.md#getclass) | **GET** /classes/{class} | Get the details of a single class\n*ClassApi* | [**getScoreSubmissions**](docs/Api/ClassApi.md#getscoresubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score\n*ClassApi* | [**getSubmission**](docs/Api/ClassApi.md#getsubmission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission\n*ClassApi* | [**getSubmissions**](docs/Api/ClassApi.md#getsubmissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students\u0026#39; submissions\n*ClassApi* | [**listAssignments**](docs/Api/ClassApi.md#listassignments) | **GET** /classes/{class}/assignments | Assignments listing\n*ClassApi* | [**listClassStudentSubmissions**](docs/Api/ClassApi.md#listclassstudentsubmissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student\n*ClassApi* | [**listClasses**](docs/Api/ClassApi.md#listclasses) | **GET** /classes | List the classes available for the current user\n*ClassApi* | [**unarchiveClass**](docs/Api/ClassApi.md#unarchiveclass) | **DELETE** /classes/{class}/archive | Unarchive the class\n*ClassApi* | [**updateClass**](docs/Api/ClassApi.md#updateclass) | **PUT** /classes/{class} | Update the class\n*CollectionApi* | [**addScoreToCollection**](docs/Api/CollectionApi.md#addscoretocollection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection\n*CollectionApi* | [**createCollection**](docs/Api/CollectionApi.md#createcollection) | **POST** /collections | Create a new collection\n*CollectionApi* | [**deleteCollection**](docs/Api/CollectionApi.md#deletecollection) | **DELETE** /collections/{collection} | Delete the collection\n*CollectionApi* | [**deleteScoreFromCollection**](docs/Api/CollectionApi.md#deletescorefromcollection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection\n*CollectionApi* | [**editCollection**](docs/Api/CollectionApi.md#editcollection) | **PUT** /collections/{collection} | Update a collection\u0026#39;s metadata\n*CollectionApi* | [**getCollection**](docs/Api/CollectionApi.md#getcollection) | **GET** /collections/{collection} | Get collection details\n*CollectionApi* | [**listCollectionScores**](docs/Api/CollectionApi.md#listcollectionscores) | **GET** /collections/{collection}/scores | List the scores contained in a collection\n*CollectionApi* | [**listCollections**](docs/Api/CollectionApi.md#listcollections) | **GET** /collections | List the collections\n*CollectionApi* | [**untrashCollection**](docs/Api/CollectionApi.md#untrashcollection) | **POST** /collections/{collection}/untrash | Untrash a collection\n*GroupApi* | [**getGroupDetails**](docs/Api/GroupApi.md#getgroupdetails) | **GET** /groups/{group} | Get group information\n*GroupApi* | [**getGroupScores**](docs/Api/GroupApi.md#getgroupscores) | **GET** /groups/{group}/scores | List group\u0026#39;s scores\n*GroupApi* | [**listGroupUsers**](docs/Api/GroupApi.md#listgroupusers) | **GET** /groups/{group}/users | List group\u0026#39;s users\n*OrganizationApi* | [**createLtiCredentials**](docs/Api/OrganizationApi.md#createlticredentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials\n*OrganizationApi* | [**createOrganizationInvitation**](docs/Api/OrganizationApi.md#createorganizationinvitation) | **POST** /organizations/invitations | Create a new invitation to join the organization\n*OrganizationApi* | [**createOrganizationUser**](docs/Api/OrganizationApi.md#createorganizationuser) | **POST** /organizations/users | Create a new user account\n*OrganizationApi* | [**listLtiCredentials**](docs/Api/OrganizationApi.md#listlticredentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials\n*OrganizationApi* | [**listOrganizationInvitations**](docs/Api/OrganizationApi.md#listorganizationinvitations) | **GET** /organizations/invitations | List the organization invitations\n*OrganizationApi* | [**listOrganizationUsers**](docs/Api/OrganizationApi.md#listorganizationusers) | **GET** /organizations/users | List the organization users\n*OrganizationApi* | [**removeOrganizationInvitation**](docs/Api/OrganizationApi.md#removeorganizationinvitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation\n*OrganizationApi* | [**removeOrganizationUser**](docs/Api/OrganizationApi.md#removeorganizationuser) | **DELETE** /organizations/users/{user} | Remove an account from Flat\n*OrganizationApi* | [**revokeLtiCredentials**](docs/Api/OrganizationApi.md#revokelticredentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials\n*OrganizationApi* | [**updateOrganizationUser**](docs/Api/OrganizationApi.md#updateorganizationuser) | **PUT** /organizations/users/{user} | Update account information\n*ScoreApi* | [**addScoreCollaborator**](docs/Api/ScoreApi.md#addscorecollaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator\n*ScoreApi* | [**addScoreTrack**](docs/Api/ScoreApi.md#addscoretrack) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score\n*ScoreApi* | [**createScore**](docs/Api/ScoreApi.md#createscore) | **POST** /scores | Create a new score\n*ScoreApi* | [**createScoreRevision**](docs/Api/ScoreApi.md#createscorerevision) | **POST** /scores/{score}/revisions | Create a new revision\n*ScoreApi* | [**deleteScore**](docs/Api/ScoreApi.md#deletescore) | **DELETE** /scores/{score} | Delete a score\n*ScoreApi* | [**deleteScoreComment**](docs/Api/ScoreApi.md#deletescorecomment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment\n*ScoreApi* | [**deleteScoreTrack**](docs/Api/ScoreApi.md#deletescoretrack) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score\n*ScoreApi* | [**editScore**](docs/Api/ScoreApi.md#editscore) | **PUT** /scores/{score} | Edit a score\u0026#39;s metadata\n*ScoreApi* | [**forkScore**](docs/Api/ScoreApi.md#forkscore) | **POST** /scores/{score}/fork | Fork a score\n*ScoreApi* | [**gerUserLikes**](docs/Api/ScoreApi.md#geruserlikes) | **GET** /users/{user}/likes | List liked scores\n*ScoreApi* | [**getGroupScores**](docs/Api/ScoreApi.md#getgroupscores) | **GET** /groups/{group}/scores | List group\u0026#39;s scores\n*ScoreApi* | [**getScore**](docs/Api/ScoreApi.md#getscore) | **GET** /scores/{score} | Get a score\u0026#39;s metadata\n*ScoreApi* | [**getScoreCollaborator**](docs/Api/ScoreApi.md#getscorecollaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator\n*ScoreApi* | [**getScoreCollaborators**](docs/Api/ScoreApi.md#getscorecollaborators) | **GET** /scores/{score}/collaborators | List the collaborators\n*ScoreApi* | [**getScoreComments**](docs/Api/ScoreApi.md#getscorecomments) | **GET** /scores/{score}/comments | List comments\n*ScoreApi* | [**getScoreRevision**](docs/Api/ScoreApi.md#getscorerevision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision\n*ScoreApi* | [**getScoreRevisionData**](docs/Api/ScoreApi.md#getscorerevisiondata) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data\n*ScoreApi* | [**getScoreRevisions**](docs/Api/ScoreApi.md#getscorerevisions) | **GET** /scores/{score}/revisions | List the revisions\n*ScoreApi* | [**getScoreSubmissions**](docs/Api/ScoreApi.md#getscoresubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score\n*ScoreApi* | [**getScoreTrack**](docs/Api/ScoreApi.md#getscoretrack) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score\n*ScoreApi* | [**getUserScores**](docs/Api/ScoreApi.md#getuserscores) | **GET** /users/{user}/scores | List user\u0026#39;s scores\n*ScoreApi* | [**listScoreTracks**](docs/Api/ScoreApi.md#listscoretracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score\n*ScoreApi* | [**markScoreCommentResolved**](docs/Api/ScoreApi.md#markscorecommentresolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved\n*ScoreApi* | [**markScoreCommentUnresolved**](docs/Api/ScoreApi.md#markscorecommentunresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved\n*ScoreApi* | [**postScoreComment**](docs/Api/ScoreApi.md#postscorecomment) | **POST** /scores/{score}/comments | Post a new comment\n*ScoreApi* | [**removeScoreCollaborator**](docs/Api/ScoreApi.md#removescorecollaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator\n*ScoreApi* | [**untrashScore**](docs/Api/ScoreApi.md#untrashscore) | **POST** /scores/{score}/untrash | Untrash a score\n*ScoreApi* | [**updateScoreComment**](docs/Api/ScoreApi.md#updatescorecomment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment\n*ScoreApi* | [**updateScoreTrack**](docs/Api/ScoreApi.md#updatescoretrack) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score\n*UserApi* | [**gerUserLikes**](docs/Api/UserApi.md#geruserlikes) | **GET** /users/{user}/likes | List liked scores\n*UserApi* | [**getUser**](docs/Api/UserApi.md#getuser) | **GET** /users/{user} | Get a public user profile\n*UserApi* | [**getUserScores**](docs/Api/UserApi.md#getuserscores) | **GET** /users/{user}/scores | List user\u0026#39;s scores\n\n\n## Documentation For Models\n\n - [Assignment](docs/Model/Assignment.md)\n - [AssignmentCopy](docs/Model/AssignmentCopy.md)\n - [AssignmentCreation](docs/Model/AssignmentCreation.md)\n - [AssignmentSubmission](docs/Model/AssignmentSubmission.md)\n - [AssignmentSubmissionUpdate](docs/Model/AssignmentSubmissionUpdate.md)\n - [ClassAttachmentCreation](docs/Model/ClassAttachmentCreation.md)\n - [ClassCreation](docs/Model/ClassCreation.md)\n - [ClassDetails](docs/Model/ClassDetails.md)\n - [ClassDetailsCanvas](docs/Model/ClassDetailsCanvas.md)\n - [ClassDetailsClever](docs/Model/ClassDetailsClever.md)\n - [ClassDetailsGoogleClassroom](docs/Model/ClassDetailsGoogleClassroom.md)\n - [ClassDetailsGoogleDrive](docs/Model/ClassDetailsGoogleDrive.md)\n - [ClassDetailsLti](docs/Model/ClassDetailsLti.md)\n - [ClassRoles](docs/Model/ClassRoles.md)\n - [ClassState](docs/Model/ClassState.md)\n - [ClassUpdate](docs/Model/ClassUpdate.md)\n - [Collection](docs/Model/Collection.md)\n - [CollectionCapabilities](docs/Model/CollectionCapabilities.md)\n - [CollectionCreation](docs/Model/CollectionCreation.md)\n - [CollectionModification](docs/Model/CollectionModification.md)\n - [CollectionPrivacy](docs/Model/CollectionPrivacy.md)\n - [CollectionTitle](docs/Model/CollectionTitle.md)\n - [CollectionType](docs/Model/CollectionType.md)\n - [FlatErrorResponse](docs/Model/FlatErrorResponse.md)\n - [FlatLocales](docs/Model/FlatLocales.md)\n - [GoogleClassroomCoursework](docs/Model/GoogleClassroomCoursework.md)\n - [GoogleClassroomSubmission](docs/Model/GoogleClassroomSubmission.md)\n - [Group](docs/Model/Group.md)\n - [GroupDetails](docs/Model/GroupDetails.md)\n - [GroupType](docs/Model/GroupType.md)\n - [LicenseMode](docs/Model/LicenseMode.md)\n - [LicenseSources](docs/Model/LicenseSources.md)\n - [LmsName](docs/Model/LmsName.md)\n - [LtiCredentials](docs/Model/LtiCredentials.md)\n - [LtiCredentialsCreation](docs/Model/LtiCredentialsCreation.md)\n - [MediaAttachment](docs/Model/MediaAttachment.md)\n - [MediaScoreSharingMode](docs/Model/MediaScoreSharingMode.md)\n - [OrganizationInvitation](docs/Model/OrganizationInvitation.md)\n - [OrganizationInvitationCreation](docs/Model/OrganizationInvitationCreation.md)\n - [OrganizationRoles](docs/Model/OrganizationRoles.md)\n - [ResourceCollaboratorCreation](docs/Model/ResourceCollaboratorCreation.md)\n - [ResourceRights](docs/Model/ResourceRights.md)\n - [ResourceSharingKey](docs/Model/ResourceSharingKey.md)\n - [ScoreComment](docs/Model/ScoreComment.md)\n - [ScoreCommentContext](docs/Model/ScoreCommentContext.md)\n - [ScoreCommentCreation](docs/Model/ScoreCommentCreation.md)\n - [ScoreCommentUpdate](docs/Model/ScoreCommentUpdate.md)\n - [ScoreCommentsCounts](docs/Model/ScoreCommentsCounts.md)\n - [ScoreCreation](docs/Model/ScoreCreation.md)\n - [ScoreCreationType](docs/Model/ScoreCreationType.md)\n - [ScoreData](docs/Model/ScoreData.md)\n - [ScoreDataEncoding](docs/Model/ScoreDataEncoding.md)\n - [ScoreFork](docs/Model/ScoreFork.md)\n - [ScoreLicense](docs/Model/ScoreLicense.md)\n - [ScoreLikesCounts](docs/Model/ScoreLikesCounts.md)\n - [ScoreModification](docs/Model/ScoreModification.md)\n - [ScorePrivacy](docs/Model/ScorePrivacy.md)\n - [ScoreRevision](docs/Model/ScoreRevision.md)\n - [ScoreRevisionCreation](docs/Model/ScoreRevisionCreation.md)\n - [ScoreRevisionStatistics](docs/Model/ScoreRevisionStatistics.md)\n - [ScoreSource](docs/Model/ScoreSource.md)\n - [ScoreSummary](docs/Model/ScoreSummary.md)\n - [ScoreTrack](docs/Model/ScoreTrack.md)\n - [ScoreTrackCreation](docs/Model/ScoreTrackCreation.md)\n - [ScoreTrackPoint](docs/Model/ScoreTrackPoint.md)\n - [ScoreTrackState](docs/Model/ScoreTrackState.md)\n - [ScoreTrackType](docs/Model/ScoreTrackType.md)\n - [ScoreTrackUpdate](docs/Model/ScoreTrackUpdate.md)\n - [ScoreViewsCounts](docs/Model/ScoreViewsCounts.md)\n - [UserAdminUpdate](docs/Model/UserAdminUpdate.md)\n - [UserBasics](docs/Model/UserBasics.md)\n - [UserCreation](docs/Model/UserCreation.md)\n - [UserDetailsAdminLicense](docs/Model/UserDetailsAdminLicense.md)\n - [UserInstruments](docs/Model/UserInstruments.md)\n - [ResourceCollaborator](docs/Model/ResourceCollaborator.md)\n - [ScoreDetails](docs/Model/ScoreDetails.md)\n - [UserPublicSummary](docs/Model/UserPublicSummary.md)\n - [UserDetailsAdmin](docs/Model/UserDetailsAdmin.md)\n - [UserPublic](docs/Model/UserPublic.md)\n - [UserDetails](docs/Model/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's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile.\n - **account.education_profile**: Provides access to the basic person's education profile and public organization information.\n - **scores.readonly**: Allows read-only access to all a user's scores. You won'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's scores.\n - **collections.readonly**: Allow read-only access to a user's collections.\n - **collections.add_scores**: Allow to add scores to a user's collections.\n - **collections**: Full, permissive scope to access all of a user'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\n## Author\n\ndevelopers@flat.io","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatio%2Fapi-client-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflatio%2Fapi-client-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatio%2Fapi-client-php/lists"}