> For the complete documentation index, see [llms.txt](https://eshop.gitbook.io/eshopbox-developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eshop.gitbook.io/eshopbox-developers/setting/workspace.md).

# Workspace

Workspaces are the core resource to any project.

## The `Workspace`Object

{% tabs %}
{% tab title="Attributes" %}

| Attributes                   | Type      | Description                                                                                                                                           |
| ---------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                         | `integer` | unique id of a workspace                                                                                                                              |
| `accountName`                | `string`  | Name of the workspace                                                                                                                                 |
| `accountSlug`                | `string`  | workspace identifier. Must be unique                                                                                                                  |
| `status`                     | `string`  | <p>Different status of a particular workspace</p><p><a href="/pages/-M0wJjDSqCfVYef8oDPK#enum-status"><code>Enum</code></a><code>: 0, 1, 2</code></p> |
| `clientCode`                 | `string`  | workspace identifier                                                                                                                                  |
| `addressLine1`               | `string`  | Registered address of the workspace                                                                                                                   |
| `addressLine2`               | `string`  | Registered address of the workspace                                                                                                                   |
| `city`                       | `string`  | Registered address of the workspace                                                                                                                   |
| `state`                      | `string`  | Registered address of the workspace                                                                                                                   |
| `pincode`                    | `string`  | Registered address of the workspace                                                                                                                   |
| `country`                    | `string`  | Registered address of the workspace                                                                                                                   |
| `email`                      | `string`  | Email id of the workspace                                                                                                                             |
| `phone`                      | `string`  | Phone number of the workspace                                                                                                                         |
| `panNumber`                  | `string`  | Pan card number of the workspace                                                                                                                      |
| `pancardScannedCopy`         | `string`  | Pan card photo of the workspace                                                                                                                       |
| `accountNumber`              | `string`  | Account number of the workspace                                                                                                                       |
| `bankName`                   | `string`  | Bank name of the  workspace                                                                                                                           |
| `ifscCode`                   | `string`  | IFSC code for workspace bank                                                                                                                          |
| `cancelledChequeScannedCopy` | `string`  | Cancelled cheque scanned copy                                                                                                                         |
| `contactPerson`              | `string`  | Contact person of the workspace                                                                                                                       |
| `gstin`                      | `string`  | GSTIN number of the workspace where registered                                                                                                        |
| `contractUrl`                | `string`  | Contract URL between workspace and Eshopbox                                                                                                           |
| `stepsCompleted`             | `integer` | Number of steps completed while enrolled workspace                                                                                                    |
| `userAccountMappingId`       | `integer` | identity the workspace and user uniquely                                                                                                              |
| `userAccountMappingStatus`   | `string`  | Status of the user on workspace                                                                                                                       |
| `userAccountMappingRole`     | `string`  | Role of the user on workspace                                                                                                                         |
| `createdAt`                  | `string`  | The time at which workspace is created                                                                                                                |
| `updatedAt`                  | `string`  | The time at which workspace is updated                                                                                                                |
| {% endtab %}                 |           |                                                                                                                                                       |

{% tab title="Sample Object" %}

```
{
   "id": 5,
   "accountName": "Kapas Kraft",
   "accountSlug": "KapasKraft",
   "status": "1",
   "clientCode": "KKPL359",
   "addressLine1": "Khasra no 5 16 2 17",
   "addressLine2": "Gundavali, Bhiwandi",
   "city": "Bangalore",
   "state": "Karnataka",
   "pincode": "122018",
   "country": "IN",
   "email": "johndoe@gmail.com",
   "phone": "9451782453",
   "panNumber": "AAA6910ZZZ",
   "pancardScannedCopy": "https://storage.cloud.google.com/panCard.appspot.com/AAA6910ZZZ.pdf",
   "accountNumber": "1234567899746",
   "bankName": "India Bank",
   "ifscCode": "SIB0003246",
   "branch": "Sector 7, Gurgaon",
   "cancelledChequeScannedCopy": "https://storage.cloud.google.com/cheque.appspot.com/cheque.pdf",
   "contactPerson": "Ram Sharma",
   "gstin": "06ABCD1234E1Z1",
   "contractUrl": "https://storage.cloud.google.com/contract.appspot.com/contract.pdf",
   "stepsCompleted": 5,
   "userAccountMappingId": 356,
   "userAccountMappingStatus": "1",
   "userAccountMappingRole": "admin",
   "createdAt": "2019-04-08T12:41:05.000+05:30",
   "updatedAt": "2019-04-08T12:41:05.000+05:30"
   
}
```

{% endtab %}
{% endtabs %}

## Enum: status

| Attributes | Descriptions                             |
| ---------- | ---------------------------------------- |
| `0`        | Workspace approval pending from Eshopbox |
| `1`        | Workspace is active                      |
| `2`        | Workspace is inactive                    |