# Fax.Plus API

## Docs

- [Get account information](https://apidoc.fax.plus/api-reference/endpoints/accounts/get-account-information.md): Get information about an account. For members user_id can only be self. For admin it can be either self, or a user_id of any corporate member. (Permitted scopes: **fax:all:read**, **fax:member:read**, **fax:user:read**)
- [Get member details](https://apidoc.fax.plus/api-reference/endpoints/accounts/get-member-details.md): Get corporate member's role and faxing quota (Permitted scopes: **fax:all:read**, **fax:member:read**)
- [Invite corporate members](https://apidoc.fax.plus/api-reference/endpoints/accounts/invite-corporate-members.md): Invite new users to join your corporate account by sending them email invitations (maximum 10 per request). Only corporate admins with appropriate permissions can use this endpoint. (Permitted scopes: **fax:all:edit**, **fax:member:edit**)
- [List corporate members](https://apidoc.fax.plus/api-reference/endpoints/accounts/list-corporate-members.md): Get account information of all non-admin members of your corporate account. Only the admin account can send a request to this endpoint which returns the accounts of all members (Permitted scopes: **fax:all:read**, **fax:member:read**)
- [Modify account information](https://apidoc.fax.plus/api-reference/endpoints/accounts/modify-account-information.md): Modify personal information of your own account or your corporate member's account. user_id can be either self, or a subordinate's user_id. (Permitted scopes: **fax:all:edit**, **fax:member:edit**, **fax:user:edit**)
- [Modify member details](https://apidoc.fax.plus/api-reference/endpoints/accounts/modify-member-details.md): Update corporate member's role and faxing quota. (Permitted scopes: **fax:all:edit**, **fax:member:edit**)
- [Resend corporate member invitations](https://apidoc.fax.plus/api-reference/endpoints/accounts/resend-member-invitations.md): Resend email invitations to users who have not yet signed up for your corporate account (maximum 10 per request). Only corporate admins with appropriate permissions can use this endpoint. (Permitted scopes: **fax:all:edit**, **fax:member:edit**)
- [Get token information](https://apidoc.fax.plus/api-reference/endpoints/authentication/get-token-info.md): Returns metadata about the current access token including type, scopes, expiration date, and PAT-specific information if applicable. For PAT tokens, returns full metadata (id, name, preview, created/expiration dates, last used). For OAuth tokens, returns token type and scopes only.
- [Assign contacts to groups](https://apidoc.fax.plus/api-reference/endpoints/contacts/assign-contacts-to-groups.md): Assign multiple contacts to multiple groups. **Important:** This operation overwrites existing group assignments for the specified contacts - it does not append to them. Contacts will be unassigned from any group that's not included in this list (Permitted scopes: **fax:all:edit**)
- [Create a contact](https://apidoc.fax.plus/api-reference/endpoints/contacts/create-contact.md): Create a new contact (Permitted scopes: **fax:all:edit**)
- [Create a group](https://apidoc.fax.plus/api-reference/endpoints/contacts/create-contact-group.md): Create a new contact group (Permitted scopes: **fax:all:edit**)
- [Delete a contact](https://apidoc.fax.plus/api-reference/endpoints/contacts/delete-contact.md): Delete a contact (Permitted scopes: **fax:all:edit**)
- [Delete a group](https://apidoc.fax.plus/api-reference/endpoints/contacts/delete-contact-group.md): Delete a group (Permitted scopes: **fax:all:edit**)
- [List contact groups](https://apidoc.fax.plus/api-reference/endpoints/contacts/list-contact-groups.md): Get contact groups with optional search and pagination. You can also retrieve specific groups by providing comma-separated IDs (Permitted scopes: **fax:all:read**)
- [List contacts](https://apidoc.fax.plus/api-reference/endpoints/contacts/list-contacts.md): Get user contacts with optional search, pagination, or retrieve specific contacts by IDs (Permitted scopes: **fax:all:read**)
- [Share groups](https://apidoc.fax.plus/api-reference/endpoints/contacts/share-contact-groups.md): Share groups with all corporate members (Permitted scopes: **fax:all:edit**)
- [Share contacts](https://apidoc.fax.plus/api-reference/endpoints/contacts/share-contacts.md): Share contacts with all corporate members (Permitted scopes: **fax:all:edit**)
- [Update a contact](https://apidoc.fax.plus/api-reference/endpoints/contacts/update-contact.md): Update an existing contact (Permitted scopes: **fax:all:edit**)
- [Update a group](https://apidoc.fax.plus/api-reference/endpoints/contacts/update-contact-group.md): Update an existing group (Permitted scopes: **fax:all:edit**)
- [Bulk delete fax records](https://apidoc.fax.plus/api-reference/endpoints/faxes/bulk-delete-fax-records.md): Bulk delete multiple fax records. Maximum 50 fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Bulk update fax records](https://apidoc.fax.plus/api-reference/endpoints/faxes/bulk-update-fax-records.md): Bulk update multiple fax records (mark as read/unread and/or update comment). Maximum 100 fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Delete a fax](https://apidoc.fax.plus/api-reference/endpoints/faxes/delete-a-fax.md): Delete a specific fax record by providing its id. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Get a fax record](https://apidoc.fax.plus/api-reference/endpoints/faxes/get-a-fax-record.md): Get a specific fax record details like duration, pages etc. (Permitted scopes: **fax:all:read**, **fax:fax:read**)
- [List fax records](https://apidoc.fax.plus/api-reference/endpoints/faxes/list-fax-records.md): Get your own or your subordinate's faxes list. (Permitted scopes: **fax:all:read**, **fax:fax:read**)
- [Modify fax record](https://apidoc.fax.plus/api-reference/endpoints/faxes/modify-fax-record.md): You can modify a fax record's comment or mark it as read. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Download fax file](https://apidoc.fax.plus/api-reference/endpoints/files/download-fax-file.md): Download sent or received fax file. (Permitted scopes: **fax:all:read**, **fax:file:read**)
- [Download single fax page](https://apidoc.fax.plus/api-reference/endpoints/files/download-fax-file-page.md): Download single page (starting with 1) of a sent or received fax file. (Permitted scopes: **fax:all:read**, **fax:file:read**)
- [Get fax confirmation report](https://apidoc.fax.plus/api-reference/endpoints/files/get-fax-confirmation-report.md): Retrieve fax confirmation report (Permitted scopes: **fax:all:read**, **fax:fax:read**)
- [Get fax thumbnail](https://apidoc.fax.plus/api-reference/endpoints/files/get-fax-thumbnail.md): Retrieve fax thumbnail (Permitted scopes: **fax:all:read**, **fax:fax:read**)
- [Upload a file](https://apidoc.fax.plus/api-reference/endpoints/files/upload-a-file.md): Before sending a fax you need to upload your files using this API. In order to upload your fax file, you have to send a `multipart/form-data` request with your file. Set the `name` to `fax_file`, `filename` to your file's name with extension, and the Content-Type to the file's MIME type. In most cas…
- [Assign number](https://apidoc.fax.plus/api-reference/endpoints/numbers/assign-number.md): Assign fax number to a corporate member (Permitted scopes: **fax:all:edit**, **fax:numbers:edit**)
- [Get number information](https://apidoc.fax.plus/api-reference/endpoints/numbers/get-number-information.md): Get information about a single purchased/assigned fax number (Permitted scopes: **fax:all:read**, **fax:numbers:read**)
- [List phone numbers](https://apidoc.fax.plus/api-reference/endpoints/numbers/list-phone-numbers.md): List your purchased/assigned phone numbers. For corporate members all assigned numbers will be returned, while for the corporate admin, all purchased numbers. (Permitted scopes: **fax:all:read**, **fax:numbers:read**)
- [Revoke number](https://apidoc.fax.plus/api-reference/endpoints/numbers/revoke-number.md): Revoke fax number from a corporate member. To revoke your own number use self as a user_id. (Permitted scopes: **fax:all:edit**, **fax:numbers:edit**)
- [Bulk delete outbox faxes](https://apidoc.fax.plus/api-reference/endpoints/outbox/bulk-delete-outbox-faxes.md): Bulk delete (cancel) multiple outbox fax records. Maximum 10 outbox fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Bulk update outbox faxes](https://apidoc.fax.plus/api-reference/endpoints/outbox/bulk-update-outbox-faxes.md): Bulk update multiple outbox fax records (update comment). Maximum 100 outbox fax IDs per request. Duplicate IDs are automatically ignored. Jobs in 'sending' status cannot be updated and will return a 409 status code. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Delete an outgoing fax](https://apidoc.fax.plus/api-reference/endpoints/outbox/delete-an-outgoing-fax.md): Delete an outgoing fax that is being scheduled for sending. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [List faxes in the outbox](https://apidoc.fax.plus/api-reference/endpoints/outbox/list-faxes-in-the-outbox.md): Get a list of the faxes in the outbox which were not yet sent. (Permitted scopes: **fax:all:read**, **fax:fax:read**)
- [Get outgoing fax](https://apidoc.fax.plus/api-reference/endpoints/outbox/list-outgoing-faxes.md): Get specific details of a fax currently scheduled for sending. (Permitted scopes: **fax:all:read**, **fax:fax:read**)
- [Modify an outgoing fax](https://apidoc.fax.plus/api-reference/endpoints/outbox/modify-an-outgoing-fax.md): Modify an outgoing fax that is being scheduled for sending. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)
- [Send a fax](https://apidoc.fax.plus/api-reference/endpoints/outbox/send-a-fax.md): Send a fax to one or more destinations. For corporate members without a fax number assigned set the 'from' parameter to 'no_number'. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**). To randomly select one of the available numbers per recipient, use comma-separated string.
- [Delete webhook](https://apidoc.fax.plus/api-reference/endpoints/webhooks/delete-webhook.md): Delete a webhook by its ID. (Permitted scopes: **fax:all:edit**, **fax:webhook:edit**)
- [List user webhooks](https://apidoc.fax.plus/api-reference/endpoints/webhooks/list-user-webhooks.md): Returns a list of currently registered webhooks for the requested **event**. (Permitted scopes: **fax:all:read**, **fax:webhook:read**)
- [Register new webhook](https://apidoc.fax.plus/api-reference/endpoints/webhooks/register-new-webhook.md): Register a new webhook which will be called on a specific event. See the WebhookCallback model. (Permitted scopes: **fax:all:edit**, **fax:webhook:edit**)
- [Javascript](https://apidoc.fax.plus/backend-sdks/javascript.md)
- [Python](https://apidoc.fax.plus/backend-sdks/python.md)
- [Authentication](https://apidoc.fax.plus/concepts/authentication.md)
- [Fax](https://apidoc.fax.plus/concepts/fax.md)
- [Number](https://apidoc.fax.plus/concepts/number.md)
- [Outbox](https://apidoc.fax.plus/concepts/outbox.md)
- [Shop](https://apidoc.fax.plus/concepts/shop.md)
- [Webhook](https://apidoc.fax.plus/concepts/webhook.md)
- [Get account balance](https://apidoc.fax.plus/endpoints/shop/get-account-balance.md): Get your account balance. (Permitted scopes: **fax:all:read**, **fax:shop:read**)
- [List areas](https://apidoc.fax.plus/endpoints/shop/list-areas.md): Get a list of areas where you can purchase fax numbers for a specific country. (Permitted scopes: **fax:all:read**, **fax:shop:read**)
- [List available numbers](https://apidoc.fax.plus/endpoints/shop/list-available-numbers.md): Get a list of available fax numbers for a specific area. (Permitted scopes: **fax:all:read**, **fax:shop:read**)
- [List countries](https://apidoc.fax.plus/endpoints/shop/list-countries.md): Get a list of countries where you can purchase fax numbers. (Permitted scopes: **fax:all:read**, **fax:shop:read**)
- [Purchase a number](https://apidoc.fax.plus/endpoints/shop/purchase-a-number.md): Purchase an available fax number. (Permitted scopes: **fax:all:edit**, **fax:shop:edit**)
- [Fax.Plus MCP Server](https://apidoc.fax.plus/get-started/fax-plus-mcp.md): Send and receive faxes from any MCP-compatible AI assistant using the Fax.Plus API
- [Introduction](https://apidoc.fax.plus/get-started/introduction.md): Integrate online fax functionalities in your workflow
- [Quickstart](https://apidoc.fax.plus/get-started/quickstart.md): Start sending faxes in 4 steps

## OpenAPI Specs

- [openapi](https://apidoc.fax.plus/api-reference/openapi.json)

## Optional

- [Knowledge Base](https://help.alohi.com/hc/en-us)
- [Release Notes](https://www.alohi.com/release-notes)
- [Compliance & Security](https://www.alohi.com/trust/compliance)
- [Blog](https://www.alohi.com/blog)