# Antsfield Docs

## Docs

- [Introduction](https://docs.antsfield.com/introduction.md): Antsfield helps trades and field-service teams track inventory across warehouses, vans, and job sites, send invoices, and keep crews in sync on web and iPhone.
- [Quick start](https://docs.antsfield.com/quick-start.md): Get your workspace running: add items, set stock, create locations, and make your first transfer.
- [Data model](https://docs.antsfield.com/data-model.md): How workspaces, items, locations, balances, transfers, and movements relate to each other.
- [Keyboard shortcuts](https://docs.antsfield.com/keyboard-shortcuts.md): Speed up everyday inventory work with keyboard shortcuts in the dashboard.
- [Workspaces](https://docs.antsfield.com/dashboard/workspaces/introduction.md): Create, switch, and configure the workspace that holds your inventory and team.
- [Items](https://docs.antsfield.com/dashboard/items/introduction.md): Create, search, filter, and manage the products in your inventory catalog.
- [Managing stock](https://docs.antsfield.com/dashboard/items/managing-stock.md): Set opening balances, adjust on-hand quantities, and view stock across locations.
- [CSV import & export](https://docs.antsfield.com/dashboard/items/import-export.md): Bulk import items from a spreadsheet and export your catalog with per-location stock for backups or reporting.
- [CSV import & export](https://docs.antsfield.com/dashboard/clients/import-export.md): Bulk import clients from a spreadsheet and export contacts with lifetime invoice stats.
- [Locations](https://docs.antsfield.com/dashboard/locations/introduction.md): Create and manage warehouses, vans, sites, and other places where you hold stock.
- [Tags](https://docs.antsfield.com/dashboard/tags/introduction.md): Organize items with colored tags and filter your inventory faster.
- [Transfers](https://docs.antsfield.com/dashboard/transfers/introduction.md): Move stock between locations instantly and keep a clear record of every movement.
- [Movements](https://docs.antsfield.com/dashboard/movements/introduction.md): Read the audit trail of every stock change in your workspace.
- [Team & members](https://docs.antsfield.com/dashboard/team/introduction.md): Invite teammates, assign roles, and control who can see which locations.
- [Billing & plans](https://docs.antsfield.com/dashboard/billing/introduction.md): Understand plans, usage limits, upgrades, and how billing works for your workspace.
- [Security](https://docs.antsfield.com/dashboard/security/introduction.md): Configure SAML SSO and SCIM provisioning for enterprise teams.
- [Account settings](https://docs.antsfield.com/dashboard/account/introduction.md): Manage your personal profile, password, and security across all workspaces.
- [API keys](https://docs.antsfield.com/dashboard/api-keys/introduction.md): Create API keys to connect Antsfield with your tools, scripts, and integrations.
- [Integrations](https://docs.antsfield.com/integrations.md): Connect Antsfield with custom tools and automation through the REST API and CSV import/export.
- [Help Center](https://docs.antsfield.com/help/index.md): Find answers about inventory, workspaces, billing, SSO, and the Antsfield API.
- [Getting started](https://docs.antsfield.com/help/category/getting-started.md): Set up your account, workspace, items, and team in Antsfield.
- [What is Antsfield?](https://docs.antsfield.com/help/article/what-is-antsfield.md): Antsfield is an inventory management platform for tracking products across locations and teams.
- [What is a workspace?](https://docs.antsfield.com/help/article/what-is-a-workspace.md): A workspace is your company's home in Antsfield — one catalog, one team, one billing plan.
- [How to create an item](https://docs.antsfield.com/help/article/how-to-create-item.md): Add a product to your Antsfield inventory catalog with SKU, description, cost, and optional opening stock.
- [How to invite teammates](https://docs.antsfield.com/help/article/how-to-invite-teammates.md): Add owners and members to your Antsfield workspace by email or invite link.
- [Inventory](https://docs.antsfield.com/help/category/inventory.md): Manage locations, transfers, stock movements, and tags in your workspace.
- [Inventory locations](https://docs.antsfield.com/help/article/inventory-locations.md): Create and manage warehouses, vans, sites, and other places where you hold stock.
- [Inventory transfers](https://docs.antsfield.com/help/article/inventory-transfers.md): Move stock between locations instantly and keep a clear record of every movement.
- [Inventory movements](https://docs.antsfield.com/help/article/inventory-movements.md): Read the audit trail of every stock change in your workspace.
- [How to use tags](https://docs.antsfield.com/help/article/how-to-use-tags.md): Create colored tags, assign them to items, and filter your inventory faster.
- [Billing](https://docs.antsfield.com/help/category/billing.md): Compare Antsfield plans and understand usage limits for your workspace.
- [Pro plan](https://docs.antsfield.com/help/article/pro-plan.md): Antsfield Pro plan limits and features for small businesses.
- [Business plan](https://docs.antsfield.com/help/article/business-plan.md): Antsfield Business plan limits and features for growing teams.
- [Advanced plan](https://docs.antsfield.com/help/article/advanced-plan.md): Antsfield Advanced plan limits and features for larger operations.
- [SAML SSO](https://docs.antsfield.com/help/category/saml-sso.md): Configure SAML single sign-on and SCIM provisioning with your identity provider.
- [Google Workspace SAML SSO](https://docs.antsfield.com/help/article/google-saml.md): Configure SAML single sign-on between Google Workspace and Antsfield.
- [Okta SAML SSO](https://docs.antsfield.com/help/article/okta-saml.md): Configure SAML single sign-on between Okta and Antsfield.
- [Azure AD SAML SSO](https://docs.antsfield.com/help/article/azure-saml.md): Configure SAML single sign-on between Microsoft Entra ID (Azure AD) and Antsfield.
- [Google Workspace SCIM](https://docs.antsfield.com/help/article/google-scim.md): Automatically provision and deprovision Antsfield users from Google Workspace.
- [Okta SCIM](https://docs.antsfield.com/help/article/okta-scim.md): Automatically provision and deprovision Antsfield users from Okta.
- [Azure AD SCIM](https://docs.antsfield.com/help/article/azure-scim.md): Automatically provision and deprovision Antsfield users from Microsoft Entra ID.
- [API](https://docs.antsfield.com/help/category/api.md): Connect Antsfield to your tools with the REST API and workspace credentials.
- [How to get your workspace ID](https://docs.antsfield.com/help/article/how-to-get-workspace-id.md): Find the workspace ID required for Antsfield API requests and integrations.
- [Introduction](https://docs.antsfield.com/api-reference/introduction.md): Fundamental concepts of Antsfield's inventory API.
- [Authentication](https://docs.antsfield.com/api-reference/authentication.md): Authenticate API requests with workspace API keys and scoped permissions.
- [Security](https://docs.antsfield.com/api-reference/security.md): How Antsfield secures the API and how to integrate safely.
- [Rate limits](https://docs.antsfield.com/api-reference/rate-limits.md): API rate limits per key and how to handle throttling.
- [Errors](https://docs.antsfield.com/api-reference/errors.md): Troubleshoot problems with this comprehensive breakdown of all error codes.
- [Create a new item](https://docs.antsfield.com/api-reference/endpoint/create-a-new-item.md): Create a new item for the authenticated workspace.
- [Retrieve an item](https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item.md): Retrieve the info for an item.
- [Update an item](https://docs.antsfield.com/api-reference/endpoint/update-an-item.md): Update an item for the authenticated workspace. If there's no change, returns it as it is.
- [Delete an item](https://docs.antsfield.com/api-reference/endpoint/delete-an-item.md): Delete an item for the authenticated workspace.
- [Retrieve a list of items](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-list-of-items.md): Retrieve a paginated list of items for the authenticated workspace.
- [Retrieve the number of items](https://docs.antsfield.com/api-reference/endpoint/retrieve-number-of-items.md): Retrieve the number of items for the authenticated workspace. The provided query parameters allow filtering the returned items.
- [Bulk create items](https://docs.antsfield.com/api-reference/endpoint/bulk-create-items.md): Bulk create up to 100 items for the authenticated workspace.
- [Create a workspace](https://docs.antsfield.com/api-reference/endpoint/create-a-new-workspace.md): Create a new workspace for the authenticated user.
- [Retrieve a workspace](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace.md): Retrieve a workspace for the authenticated user.
- [Retrieve a list of workspaces](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-list-of-workspaces.md): Retrieve a list of workspaces for the authenticated user.
- [Create a new tag](https://docs.antsfield.com/api-reference/endpoint/create-a-new-tag.md): Create a new tag for the authenticated workspace.
- [Retrieve a list of tags](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-list-of-tags.md): Retrieve a list of tags for the authenticated workspace.
- [Create a location](https://docs.antsfield.com/api-reference/endpoint/create-a-location.md): Create a new storage location in the authenticated workspace. Requires `locations.write` scope. Workspace owners only when the token user has restricted location access.
- [Retrieve a location](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-location.md): Retrieve a single location by ID.
- [Update a location](https://docs.antsfield.com/api-reference/endpoint/update-a-location.md): Update a location's name, type, note, or active status. Requires `locations.write` scope.
- [Delete a location](https://docs.antsfield.com/api-reference/endpoint/delete-a-location.md): Delete a location. Fails if the location still has on-hand stock or is the workspace default location. Requires `locations.write` scope.
- [Retrieve a list of locations](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-list-of-locations.md): Retrieve a paginated list of locations for the authenticated workspace.
- [Retrieve the number of locations](https://docs.antsfield.com/api-reference/endpoint/retrieve-number-of-locations.md): Retrieve the number of locations for the authenticated workspace. Query parameters filter the count. Requires `locations.read` scope.
- [List inventory balances](https://docs.antsfield.com/api-reference/endpoint/list-inventory-balances.md): Retrieve on-hand quantities per item and location. Requires `inventory.read` scope. Results respect location access for restricted members.
- [Set on-hand stock](https://docs.antsfield.com/api-reference/endpoint/set-on-hand-stock.md): Set the absolute on-hand quantity for an item at a location. Creates an opening or adjustment movement in the ledger. Requires `inventory.write` scope.
- [List inventory movements](https://docs.antsfield.com/api-reference/endpoint/list-inventory-movements.md): Retrieve the append-only stock ledger for the workspace. Requires `inventory.read` scope.
- [Create a transfer](https://docs.antsfield.com/api-reference/endpoint/create-a-transfer.md): Move stock between two locations instantly. Requires sufficient on-hand quantity at the source location and `transfers.write` scope. Counts toward your workspace transfer limit.
- [Retrieve a transfer](https://docs.antsfield.com/api-reference/endpoint/retrieve-a-transfer.md): Retrieve a single transfer order by ID, including line items, locations, and related movements. Requires `transfers.read` scope.
- [List transfers](https://docs.antsfield.com/api-reference/endpoint/list-transfers.md): Retrieve transfer orders for the workspace. Requires `transfers.read` scope.
- [Revert a transfer](https://docs.antsfield.com/api-reference/endpoint/revert-a-transfer.md): Undo a completed transfer and restore prior stock levels. Only workspace owners can revert. Requires `transfers.write` scope.

## OpenAPI Specs

- [api.antsfield](https://api.antsfield.com)