How can I download a team member's faxes using API?

Updated March 19, 2024 15:30

Who can use this feature?

Available on Enterprise plan.

All members.

The Fax.Plus API offers a powerful solution for seamlessly gathering information and received fax files from your team members, granted they hold a lower position within the team's hierarchical structure.

Note: Make sure that you have completed the initial authentication process and have successfully logged in to the API. For additional instructions, refer to our guide here.

Step 1: Retrieve the list of your team member

Before you proceed, please verify that the intended team member holds a position subordinate to the API user within the team's hierarchy structure. As illustrated in the screenshots below, the Test Admin's account is capable of seamlessly connecting to the API, thereby granting access to critical information and fax files belonging to the Test Member.

FAX.PLUS-API-Member-Fax-Access-1.png

To obtain the list of all corporate members, initiate an HTTP GET request to the following URL: https://restapi.fax.plus/v3/accounts/.

Make sure to include the following headers in your request:

Content-Type:
```
multipart/form-data
```
Authorization:
```
Bearer [access token]
```
x-fax-clientid:
```
[client ID]
```

You'll have the capability to access the member's details, including the UID (User ID), which will be included in the retrieved data.

Step 2: Access faxes received by your team member

After acquiring the member's user ID, accessing their received faxes becomes a streamlined process. To do so, just initiate an HTTP GET request to the following URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox.

Make sure to include the following headers in your request:

- Authorization:
```
Bearer [access token]
```

- x-fax-clientid:
```
[client ID]
```

The fax ID can be retrieved from the response.

Note: You might want to consider setting up a dedicated webhook for the "fax_received" event, which will not only furnish you with the event's fax ID but also offer further insights. Delve deeper into this by exploring additional information. For additional information, refer to our guide here.

Step 3: Download your team member's received faxes

To retrieve the files from the fax, you can initiate an HTTP GET request by accessing the following URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf.

Make sure to include the following headers in your request:

- Authorization:
```
Bearer [access token]
```
- x-fax-clientid:
```
[client ID]
```

FAX.PLUS-API-Member-Fax-Access-5.png

Need Support?