> ## Documentation Index
> Fetch the complete documentation index at: https://docs.letsflow.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Firstbase

> Manage Firstbase employee equipment orders, assets, and retrievals.

export const flowWebUrl = "https://app.letsflow.ai";

Connect Firstbase to manage employee equipment and profiles from Flow automations. Choose which teams can use the connection. Enable Automation for each team before it can run Firstbase actions. This connection does not sync Assets or Knowledge.

<Tabs>
  <Tab title="API key">
    ### Prepare in Firstbase

    Your Firstbase organization must have API access enabled. Ask your Firstbase customer success manager if API Access is missing from Settings.

    1. Sign in to the [Firstbase app](https://app.firstbasehq.com) as an organization administrator.
    2. Open **Settings**, then **API Access** and **API Credentials**.
    3. Create an API token.
    4. Copy the token and store it in your password manager. Firstbase displays it only once.

    The token uses your organization's API access. Some operations require features enabled by Firstbase. See the [Firstbase API guide](https://support.firstbase.com/hc/en-us/articles/41586057642775-Firstbase-API-What-s-available-and-how-to-use-it) for access requirements and token management.

    Firstbase tokens do not expire by default. To rotate a token, create a replacement, reconnect the Flow connection with the replacement, and revoke the previous token after the connection succeeds.

    #### Connection troubleshooting

    Flow checks inventory access before it completes setup. If the key is rejected, confirm that API access is enabled and the token is current. A forbidden response can also mean the requested feature is unavailable for your Firstbase organization. Contact Firstbase to confirm access. If Firstbase is temporarily unavailable, retry setup when it recovers.

    ### Connect in Flow

    <Steps>
      <Step title="Find the Firstbase integration">
        1. Open **Integrations**.
        2. Choose **Add connection**.
        3. In **Add connection**, search for **Firstbase**.
        4. Select the **Firstbase** card.

        <a className="flow-app-link" href={flowWebUrl}>
          Open Flow

          <svg aria-hidden="true" viewBox="0 0 24 24" width="14" height="14" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
            <path d="M7 7h10v10" />

            <path d="M7 17 17 7" />
          </svg>
        </a>
      </Step>

      <Step title="Connect">
        1. Pick the team that will use the connection.
        2. Give the connection a name and select **Continue** through the setup steps.
        3. Select **Connect** to open the credential form.
        4. Enter the token in **Firstbase API key** and submit the form.
        5. After connection completes, enable **Automation** for each team that needs it.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Permissions and scopes

This integration does not define provider scopes.

## Supported actions

| Action | Description | <Tooltip tip="Risk estimates the impact of the action. Low reads provider data, medium changes existing records, and high can grant access, remove data, disable resources, or make broad changes.">Risk</Tooltip> |
| - | - | - |
| Approve an order | Approves equipment orders as the explicit administrative approval step. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Create a new equipment order for a person or office | Creates equipment orders for employee or office provisioning. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Create a new person (employee) in Firstbase via SCIM | Creates an employee record via SCIM for onboarding and provisioning. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Create a return | Creates a return to recover equipment from employees or offices. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Create ITAD requests | Creates ITAD requests for secure asset disposition; explicit approval is required before use. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Get a Firstbase person by their SCIM ID | Retrieves a person by SCIM ID to verify identity and lifecycle state. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| Get a single inventory item by ID | Retrieves a specific inventory item to verify its current details and state before action. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| Get a single order by ID | Retrieves an order to verify details and status before modification or approval. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| Get a single return order by ID | Retrieves a return record to verify status and details during recovery. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| List all orders for the authenticated organization | Lists canonical v1 equipment orders for queue monitoring and workflow lookup. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| List all returns | Lists return records for offboarding and equipment-recovery monitoring. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| List eligible ITAD assets | Identifies assets eligible for IT asset disposition before initiating decommissioning. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| List inventory items for the authenticated organization | Lists organization inventory so automations can locate assets for assignment, support, return, or disposal workflows. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| List people in the organization via SCIM | Lists Firstbase people via SCIM to locate employees for lifecycle and equipment workflows. | <Badge color="green" size="sm" shape="pill">low</Badge> |
| Offboard a person. | Offboards a person to trigger the core leaver workflow; explicit approval is required before use. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Replace a Firstbase person's profile via SCIM (full update) | Updates a person's profile via the canonical SCIM operation for lifecycle changes. | <Badge color="red" size="sm" shape="pill">high</Badge> |
| Update inventory details | Updates inventory details for core asset administration and reconciliation workflows. | <Badge color="red" size="sm" shape="pill">high</Badge> |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.