How can I download a member's received faxes via API?

The FAX.PLUS API allows you to collect the information and received fax files of your members across the team, as long as they have a lower place in the team's hierarchy structure.

<span class="info">Make sure you have already setup the initial authentication flow and logged in on the API. Learn more</span>

‍

Get the list of members in your team

Make sure the member is below the API user in the team's hierarchy structure. For example, in the screenshots below, Test Admin’s account can connect to the API to collect the information and fax files of the Test Member.

‍

To get the list of all corporate members, send a HTTP GET to <span class="code">https://restapi.fax.plus/v3/accounts/</span>

with the following headers:

• Content-Type: <span class="code">multipart/form-data</span>

• Authorization: <span class="code">Bearer [access token]</span>

• x-fax-clientid: <span class="code">[client ID]</span>
  

‍

You should see the member's information, including the UID (user ID).

‍

Get the list of received faxes for the member

Once we have the member's user ID, we can use it to retrieve the list of all its received faxes with a HTTP GET to <span class="code">https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox</span>

with the headers:

• Authorization: <span class="code">Bearer [access token]</span>

• x-fax-clientid: <span class="code">[client ID]</span>
  

‍

You can see the fax ID in the response.

<span class="info">You can also create a webhook for the fax_received event to have the fax ID. Learn more</span>

‍

Downloading the received fax file

To get the file from the fax, you can do a HTTP GET to <span class="code">https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf</span>

with the headers:

• Authorization: <span class="code">Bearer [access token]</span>

• x-fax-clientid: <span class="code">[client ID]</span>