---
title: How to access the FACS API
description: FACS provides an Open API that lets you access your Account and Project data programmatically. You can explore and test the API in your web browser using our interactive Swagger documentation page.
---

[Skip to content](https://support.facsware.com/knowledge/how-to-access-the-facs-api#main-content)

[Need Help?](https://support.facsware.com/knowledge/kb-tickets/new?hsLang=en)

![logo\_2x.png\]](https://support.facsware.com/hs-fs/hubfs/FACS_January_2020/Images/logo_2x.png?height=40&name=logo_2x.png)

Open main navigation

Close main navigation

- [Need Help?](https://support.facsware.com/knowledge/kb-tickets/new)

 Hello. How can we help?

- There are no suggestions because the search field is empty.

1. [Knowledge Base](https://support.facsware.com/knowledge?hsLang=en)
2. [FAQs](https://support.facsware.com/knowledge/faqs?hsLang=en)

# How to access the FACS API

## FACS provides an Open API that lets you access your Account and Project data programmatically. You can explore and test the API in your web browser using our interactive Swagger documentation page.

**![](https://support.facsware.com/hs-fs/hubfs/image-png-Nov-18-2026-10-12-33-3931-PM.png?width=670&height=418&name=image-png-Nov-18-2026-10-12-33-3931-PM.png)**

**Before You Begin**

- You need an **active FACS user account** with an email address and password.
- The API respects your existing permissions. You can only see and change the Accounts, Projects, and entries you can access in the Platform. If you can't see something in the Platform, you won't see it through the API either.
- If you need access to additional Projects, contact your Account Administrator.

**Opening the Swagger Page**

1. In your web browser, go to **[https://hub-api.facsware.com/documentation#/](https://hub-api.facsware.com/documentation#/)**.
2. The page lists all available API requests, grouped into sections such as **auth**, **Users**, **Projects**, **Documents**, and **Reports**.
3. Click any section to expand it and see its requests. Click a request to view its details.

Each request shows a method label:

- **GET** retrieves information without changing anything.
- **POST** creates something or performs an action.
- **PATCH** updates existing information.
- **DELETE** removes information.

**Step 1: Log In**

Logging in confirms who you are and returns an **access token**. You'll use this token to authorize your other requests.

1. Expand the **auth** section.
2. Click **POST /api/v1/auth/login**.
3. Click **Try it out**.
4. In the **Request body**, replace the example values with your FACS login details:

```
{   "email": "you@yourcompany.com",   "password": "your-password",   "rememberMe": false }
```

1. Click **Execute**.
2. Scroll down to **Server response**. A successful login returns a **201** response code.
3. In the response body, find your **access token**. It is a long string of letters and numbers. Copy the token value without the surrounding quotation marks.

**NOTE:** If you receive a **401** response, check your email and password and try again. If your account is locked after multiple failed attempts, contact your Account Administrator or FACS Support.

After you click Execute, Swagger displays your request, including your password, in the **Curl** box on the page. Don't share screenshots of this page or copy the Curl command into emails or tickets.

 

**Step 2: Authorize Your Session**

Authorizing tells Swagger to send your access token with every request you make.

1. Scroll to the top of the page and click the **Authorize** button.
2. In the **bearer (http, Bearer)** box, paste the access token you copied. Paste only the token. Don't add the word "Bearer" in front of it.
3. Click **Authorize**, then click **Close**.

The lock icons next to the requests now appear closed, which means your session is authorized.

**NOTE:**  Your token expires after a period of time. If your requests start returning **401 Unauthorized**, log in again (Step 1) and authorize with the new token (Step 2).

 

**Step 3: Confirm Your Account**

If you belong to more than one FACS Account, such as your company's Account and an Account where you're a Guest user, confirm which Account you're working in before you request Project data.

1. In the **auth** section, click **GET /api/v1/auth/accounts**.
2. Click **Try it out**, then **Execute**.
3. The response lists every Account you can access, with each Account's **id**, **accountName**, and whether it's your **primary** Account or one where you're a **guest**.

To work in a different Account:

1. Click **POST /api/v1/auth/switch-account**.
2. Click **Try it out**.
3. Enter the **id** of the Account you want, for example: (
4. Click **Execute**. The response includes a **new access token** for that Account.
5. Click **Authorize** at the top of the page, click **Logout** in the bearer box, paste the new token, and click **Authorize** again.

```
{   "accountId": "the-account-id" }
```

If you belong to only one Account, you can skip this step.

 

**Step 4: View Your Projects**

Now you can request your Project information.

### List the Projects Assigned to You

1. Expand the **Users** section.
2. Click **GET /api/v1/users/projects**.
3. Click **Try it out**, then **Execute**.
4. The response lists each Project you're assigned to, including its **id**, **name**, **number**, **contractor**, **engineer**, **contract number**, dates, and **Project Group**.

To see only the Projects in a specific Project Group, enter the group's ID in the **projectGroupId** field before clicking Execute.

### View a Single Project

1. Copy the **id** of a Project from the list.
2. Expand the **Projects** section and click **GET /api/v1/projects/{id}**.
3. Click **Try it out** and paste the Project ID into the **id** field.
4. Click **Execute**.

The response shows the Project's full details, including its state (**Published** or **Archived**), time zone, address, Document Templates, and assigned users.

**CAUTION: API Changes Are Real and Permanent**

Requests you run in Swagger act on your **live FACS data**, not a test copy. Any **POST**, **PATCH**, or **DELETE** request, including Archive, Delete, and Bulk actions, changes your data immediately, just as if you'd made the change in the Platform. **There is no undo.**

- If you're exploring the API, stick to **GET** requests, which only read information.
- Double-check IDs and request bodies before you click **Execute** on any request that changes data.
- If you aren't sure what a request does, contact FACS Support before you run it.

 

**Logging Out**

When you're finished:

1. In the **auth** section, click **POST /api/v1/auth/logout**, then **Try it out** and **Execute**.
2. Click **Authorize** at the top of the page and click **Logout** to clear the token from Swagger.

Closing the browser tab also clears the token from Swagger, but logging out ends your session right away.

 

**Common Response Codes**

| Code | Meaning |
| --- | --- |
| **200 / 201** | The request succeeded. |
| **400** | The request body or parameters are invalid. Check the values you entered. |
| **401** | You aren't logged in, your token expired, or you don't have access to that Account. Log in and authorize again. |
| **403** | Your role doesn't allow this action. |
| **404** | The item wasn't found, or you don't have access to it. |

 

If you have any questions, or need additional assistance, please reach out to our support team at [support@facsware.com](mailto:support@facsware.com) and we will be happy to assist you.

- [Getting Started](https://support.facsware.com/knowledge/getting-started?hsLang=en#main-content)

    - [User Preferences](https://support.facsware.com/knowledge/getting-started?hsLang=en#user-preferences)
- [Account Settings](https://support.facsware.com/knowledge/account-settings?hsLang=en)
- [Project Settings](https://support.facsware.com/knowledge/project-settings?hsLang=en)
- [Standard Documents](https://support.facsware.com/knowledge/standard-documents?hsLang=en)
- [List Library](https://support.facsware.com/knowledge/list-library?hsLang=en)
- [Document Library](https://support.facsware.com/knowledge/document-library?hsLang=en)
- [Reports](https://support.facsware.com/knowledge/reports?hsLang=en)
- [Billing](https://support.facsware.com/knowledge/billing?hsLang=en)
- [Release Notes](https://support.facsware.com/knowledge/release-notes?hsLang=en#main-content)

    - [2026](https://support.facsware.com/knowledge/release-notes?hsLang=en#2026)
    - [2025](https://support.facsware.com/knowledge/release-notes?hsLang=en#2025)
- [FAQs](https://support.facsware.com/knowledge/faqs?hsLang=en)
- [Mobile iOS](https://support.facsware.com/knowledge/mobile-ios?hsLang=en)

[![FACS](https://support.facsware.com/hs-fs/hubfs/FACS%20Logo%20FINAL.jpg?width=200&height=100&name=FACS%20Logo%20FINAL.jpg "FACS")](http://www.facsware.com)

Copyright © 2026, FACS