PHPackages alohi/faxplus-api - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. alohi/faxplus-api ActiveLibrary[API Development](/categories/api) alohi/faxplus-api ================= 244628[1 issues](https://github.com/alohi/faxplus-php/issues)[1 PRs](https://github.com/alohi/faxplus-php/pulls)PHP Since Jun 10Pushed 4y ago7 watchersCompare [ Source](https://github.com/alohi/faxplus-php)[ Packagist](https://packagist.org/packages/alohi/faxplus-api)[ RSS](/packages/alohi-faxplus-api/feed)WikiDiscussions master Synced 3w ago READMEChangelogDependenciesVersions (1)Used By (0) FAX.PLUS PHP SDK ================ [](#faxplus-php-sdk) This is the FAX.PLUS API v1 developed for third party developers and organizations. In order to have a better coding experience with this API, let's quickly go through some points: - This API assumes **/accounts** as an entry point with the base url of ****. - This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC** - Once you have an access\_token, you can easily send a request to the resource server with the base url of **** to access your permitted resources. As an example to get the user's profile info you would send a request to **** when **Authorization** header is set to "Bearer YOUR\_ACCESS\_TOKEN" and custom header of **x-fax-clientid** is set to YOUR\_CLIENT\_ID Requirements ------------ [](#requirements) PHP 5.5 and later Installation & Usage ------------------------ [](#installation--usage) ### Composer [](#composer) You can simply run `composer require faxplus/faxplus-api` to add faxplus-api to your composer.json and install it (faxplus-api is published to packagist). Alternatively, to install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json` or your local composer config: ``` { "repositories": [ { "type": "git", "url": "https://github.com/alohi/faxplus-php.git" } ], "require": { "faxplus/faxplus-api": "*@dev" } } ``` Then run `composer install` Getting Started --------------- [](#getting-started) There's a [sample application](https://github.com/alohi/faxplus-sample-php) which is intended to get you started using this SDK. Follow sample app instructions to run your first app. Documentation for API Endpoints ------------------------------- [](#documentation-for-api-endpoints) All URIs are relative to ** ClassMethodHTTP requestDescription*AccountsApi*[**getAccounts**](docs/Api/AccountsApi.md#getaccounts)**GET** /accountsGet account information of all members of your corporate account*AccountsApi*[**getMemberDetails**](docs/Api/AccountsApi.md#getmemberdetails)**GET** /accounts/self/member-details/{member\_id}Get member details*AccountsApi*[**getUser**](docs/Api/AccountsApi.md#getuser)**GET** /accounts/{user\_id}Get account information for admin or member*AccountsApi*[**updateMemberDetails**](docs/Api/AccountsApi.md#updatememberdetails)**PUT** /accounts/self/member-details/{member\_id}Modify member details*AccountsApi*[**updateUser**](docs/Api/AccountsApi.md#updateuser)**PUT** /accounts/selfModify account information*ArchivesApi*[**deleteFax**](docs/Api/ArchivesApi.md#deletefax)**DELETE** /accounts/self/archives/{fax\_id}Delete a fax*ArchivesApi*[**getFax**](docs/Api/ArchivesApi.md#getfax)**GET** /accounts/self/archives/{fax\_id}Get a fax record*ArchivesApi*[**listFaxes**](docs/Api/ArchivesApi.md#listfaxes)**GET** /accounts/{user\_id}/archivesGet fax records*ArchivesApi*[**updateFax**](docs/Api/ArchivesApi.md#updatefax)**PUT** /accounts/self/archives/{fax\_id}Modify fax record*FilesApi*[**getFile**](docs/Api/FilesApi.md#getfile)**GET** /accounts/self/files/{fax\_id}get a file*FilesApi*[**uploadFile**](docs/Api/FilesApi.md#uploadfile)**POST** /accounts/self/filesupload a file*NumbersApi*[**getNumber**](docs/Api/NumbersApi.md#getnumber)**GET** /accounts/self/numbers/{number}Get number information*NumbersApi*[**listNumbers**](docs/Api/NumbersApi.md#listnumbers)**GET** /accounts/self/numbersGet your numbers*NumbersApi*[**revokeNumber**](docs/Api/NumbersApi.md#revokenumber)**DELETE** /accounts/self/numbers/{number}Revoke number*NumbersApi*[**updateNumber**](docs/Api/NumbersApi.md#updatenumber)**PUT** /accounts/self/numbers/{number}Assign number*OutboxApi*[**deleteOutboxFax**](docs/Api/OutboxApi.md#deleteoutboxfax)**DELETE** /accounts/self/outbox/{outbox\_fax\_id}Delete a fax from outbox*OutboxApi*[**getOutboxFax**](docs/Api/OutboxApi.md#getoutboxfax)**GET** /accounts/self/outbox/{outbox\_fax\_id}Get an outbox record*OutboxApi*[**listOutboxFaxes**](docs/Api/OutboxApi.md#listoutboxfaxes)**GET** /accounts/self/outboxGet outbox records*OutboxApi*[**sendFax**](docs/Api/OutboxApi.md#sendfax)**POST** /accounts/self/outboxSend a fax*OutboxApi*[**updateOutboxFax**](docs/Api/OutboxApi.md#updateoutboxfax)**PUT** /accounts/self/outbox/{outbox\_fax\_id}Modify a fax record in outboxDocumentation For Models ------------------------ [](#documentation-for-models) - [Account](docs/Model/Account.md) - [AccountAccountData](docs/Model/AccountAccountData.md) - [AccountSettings](docs/Model/AccountSettings.md) - [AccountSettingsSendFax](docs/Model/AccountSettingsSendFax.md) - [AccountSettingsSendFaxRetry](docs/Model/AccountSettingsSendFaxRetry.md) - [Error](docs/Model/Error.md) - [Fax](docs/Model/Fax.md) - [FaxCostDetails](docs/Model/FaxCostDetails.md) - [File](docs/Model/File.md) - [MemberDetail](docs/Model/MemberDetail.md) - [Number](docs/Model/Number.md) - [NumberNotifications](docs/Model/NumberNotifications.md) - [Outbox](docs/Model/Outbox.md) - [OutboxComment](docs/Model/OutboxComment.md) - [OutboxFileChanges](docs/Model/OutboxFileChanges.md) - [OutboxFiles](docs/Model/OutboxFiles.md) - [OutboxInitiatedFrom](docs/Model/OutboxInitiatedFrom.md) - [OutboxStatusChanges](docs/Model/OutboxStatusChanges.md) - [PayloadFaxModification](docs/Model/PayloadFaxModification.md) - [PayloadNumberModification](docs/Model/PayloadNumberModification.md) - [PayloadOutbox](docs/Model/PayloadOutbox.md) - [PayloadOutboxComment](docs/Model/PayloadOutboxComment.md) - [PayloadOutboxModification](docs/Model/PayloadOutboxModification.md) - [PayloadOutboxOptions](docs/Model/PayloadOutboxOptions.md) - [PayloadOutboxOptionsRetry](docs/Model/PayloadOutboxOptionsRetry.md) - [ResponseAccountList](docs/Model/ResponseAccountList.md) - [ResponseArchive](docs/Model/ResponseArchive.md) - [ResponseArchiveData](docs/Model/ResponseArchiveData.md) - [ResponseNumberList](docs/Model/ResponseNumberList.md) - [ResponseOutboxList](docs/Model/ResponseOutboxList.md) Documentation For Authorization ------------------------------- [](#documentation-for-authorization) fax\_oauth ---------- [](#fax_oauth) - **Type**: OAuth - **Flow**: accessCode - **Authorization URL**: [https://accounts.fax.plus/login?response\_type=code&client\_id=YOUR\_CLIENT\_ID&redirect\_uri=http://localhost&scope=all](https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all) - **Scopes**: - **all**: for now when a user grant permission, all grants will be permitted ### Health Score 26 — LowBetter than 41% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity24 Limited adoption so far Community13 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/39754451?v=4)[Alohi](/maintainers/alohi)[@alohi](https://github.com/alohi) --- Top Contributors [![alohi](https://avatars.githubusercontent.com/u/39754451?v=4)](https://github.com/alohi "alohi (1 commits)") --- Tags alohiapifaxfaxplusphpphp-apiphp-sdk ### Embed Badge ![Health badge](/badges/alohi-faxplus-api/health.svg) ``` [![Health](https://phpackages.com/badges/alohi-faxplus-api/health.svg)](https://phpackages.com/packages/alohi-faxplus-api) ``` ### Alternatives [exsyst/swagger A php library to manipulate Swagger specifications 35916.4M7](/packages/exsyst-swagger)[hubspot/api-client Hubspot API client 24016.2M19](/packages/hubspot-api-client)[pocketmine/bedrock-protocol An implementation of the Minecraft: Bedrock Edition protocol in PHP 172445.0k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram Telegram driver for BotMan 93459.5k6](/packages/botman-driver-telegram) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)