---
title: "Get Business"
method: GET
path: "/v3.0/businesses/{slug}/"
tags: ["businesses"]
---

# Get Business

`GET /v3.0/businesses/{slug}/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/businesses/{slug}/`
- Auth: none declared. Required headers: `x-api-key`

# Business (Workspace)

Use to get a business's data using it's identifier (`business_identifier`).

## Reading the current business plan

If you read a business’s data from ICAS, you can see the currently active plan deal along with the business data.

**Fields:** This endpoint gives you a business that you have access to. This data may include various fields:'

- `access_level`: Your access level on the business, which can be:
  - `owner` This belongs to you and you have full access to it.
  - `admin` For future purposes, won’t be returned for now.
  - `team_member` Read-only access to business. You can’t edit the business, and can’t see or edit its members and invitations.

### Example

``` json
// **Request**
https://formaloo_api_server/v2.0/businesses/{business_slug}/ (GET)

// **Response**
{
    "status": 200,
    "errors": {
        "general_errors": [],
        "form_errors": {}
    },
    "data": {
        "object": {
            "access_level": "owner",
            "plan": {
                "plan": {
                    "title": "Enterprise",
                    "plan_type": "enterprise",
                    "description": "",
                    "slug": "gjhjfg"
                },
                "slug": "enterprise_1",
                "title": "Monthly Enterprise",
                "display_title": "Monthly Enterprise - Silver",
                "description": ""
            },
            "title": "John Doe",
            "description": null,
            "slug": "oUmtrSgO",
            "last_update": null,
            "business_services": [
                ...
            ],
            "business_identifier": "oUmtrSgO",
            "extra_data": {},
            "icon": "https://api.staging.formaloo.net/media/businesses/f2e8d86686deb47e/icons/acc127df-65d9-40ce-93b9-5a1ba4cc2a3a.jpg",
            "fav_icon": "https://api.staging.formaloo.net/media/businesses/f2e8d86686deb47e/favicons/104b0f7a-23ed-4e4e-8045-12f6100ac6a6.jpg",
            "features_visibility": {
                "templates": false,
                "old_dashboard": true
                "a_feature": true,
                "another_component": false,
            }
        }
    }
}
```

### Example: No active plan

``` json
// **Request**
https://formaloo_api_server/v2.0/businesses/{business_slug}/ (GET)

// **Response**
{
    "status": 200,
    "errors": {
        "general_errors": [],
        "form_errors": {}
    },
    "data": {
        "object": {
            "access_level": "team_member",
            "plan": null,
            "title": "John Doe",
            "description": null,
            "slug": "oUmtrSgO",
            "last_update": null,
            "business_services": [
                ...
            ],
            "business_identifier": "oUmtrSgO",
            "extra_data": {}
        }
    }
}
```

## Reading the available features

Based on the current plan, and current user's access level on the business, the backend will give you a list of feature available for the current user:

``` json
{
    "status": 200,
    "errors": {
        "general_errors": [],
        "form_errors": {}
    },
    "data": {
        "object": {
            "plan": {
                "plan": {
                    "title": "Enterprise",
                    "plan_type": "enterprise",
                    "description": "<p>HII</p>",
                    "slug": "NCNetR5Q"
                },
                "slug": "GaBs40dG",
                "title": "Enterprise - Quarterly",
                "display_title": "Enterprise - Quarterly",
                "is_subscription": false,
                "subscription_period": "---",
                "description": "",
                "is_trial": false
            },
            "title": "My Workspace",
            ...
            "available_features": [
                {
                    "title": "White Label",
                    "slug": "u3iXpQgf",
                    "description": "",
                    "available": true,
                    "upgradable": true
                },
                {
                    "title": "AI",
                    "slug": "ai",
                    "description": "",
                    "available": false,
                    "upgradable": true
                },
                {
                    "title": "API",
                    "slug": "api",
                    "description": "",
                    "available": true,
                    "upgradable": true
                },
                {
                    "title": "Email",
                    "slug": "email",
                    "description": "",
                    "available": true,
                    "upgradable": true
                },
                {
                    "title": "Payment",
                    "slug": "payment",
                    "description": "",
                    "available": false,
                    "upgradable": true
                },
                {
                    "title": "Survey",
                    "slug": "survey",
                    "description": "",
                    "available": false,
                    "upgradable": true
                },
                {
                    "title": "Translation",
                    "slug": "translation",
                    "description": "",
                    "available": false,
                    "upgradable": false
                }
            ]
        }
    }
}
```

## Path parameters

- `slug` string, required

## Headers

- `x-api-key` string, required

## Response `200`

- Business
  - `plan` string
  - `title` string, required: business entity's title.
  - `description` string, nullable: any description on the business.
  - `slug` string, nullable
  - `last_update` string, date-time, nullable: shows when was the user base data updated last time.
  - `business_identifier` string, nullable
  - `extra_data` unknown
  - `access_level` string
  - `logo` string, uri, nullable: a logo for the business
  - `icon` string, uri
  - `fav_icon` string, uri
  - `forms_subdomain` string, nullable: a subdomain to for showing the business' forms.
  - `forms_custom_domain` string, nullable: user can set this on their business, if they want to show their forms on a custom domain (e.g. https://example.co/form_address/).
  - `boards_custom_domain` string, nullable: user can set this on their business, if they want to show their boards on a custom domain (e.g. https://example.co/app_address/).
  - `dashboard_custom_domain` string, nullable: user can set this on their business, if they want to show their dashboard on a custom domain (e.g. https://dash.example.co/).
  - `dashboard_address` string
  - `total_available_seats` integer
  - `used_seats` integer
  - `white_label` boolean
  - `available_features` string: List of available features for this business.
  - `features_visibility` unknown
  - `used_trial` boolean: has the business used a trial before?

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)