> For the complete documentation index, see [llms.txt](https://docs.transactionlink.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.transactionlink.io/docs/v1/integrations/companies-house/public-data-api/uk-establishments.md).

# UK Establishments

### Output

<table><thead><tr><th>Attribute</th><th>Type</th><th width="237">Description</th><th>Additional</th></tr></thead><tbody><tr><td>etag</td><td>string</td><td>The ETag of the resource.</td><td></td></tr><tr><td><a href="#uk-establishment-company-item">items</a></td><td>array</td><td>List of UK Establishment companies.</td><td></td></tr><tr><td>kind</td><td>string</td><td><p></p><p>UK Establishment companies.</p><p>Possible values are:</p><ul><li><code>ukestablishment-companies</code></li></ul></td><td></td></tr><tr><td><a href="#links">links</a></td><td>object</td><td>UK Establishment Resources related to this company.</td><td></td></tr></tbody></table>

### **UK Establishment Company Item**

| Attribute            | Type   | Description                        | Additional |
| -------------------- | ------ | ---------------------------------- | ---------- |
| companyName          | string | The name of the company.           |            |
| companyNumber        | string | The number of the company.         |            |
| companyStatus        | string | Company status.                    |            |
| [links](#item-links) | object | Resources related to this company. |            |
| locality             | string | The locality, e.g., London.        | Optional   |

### Links

| Attribute | Type   | Description           |
| --------- | ------ | --------------------- |
| self      | string | Link to this company. |

### Item Links

| Attribute | Type   | Description              | Additional |
| --------- | ------ | ------------------------ | ---------- |
| company   | string | The link to the company. | Optional   |

### Example

```
{
    "etag": "abc123",
    "items": [
        {
            "companyName": "Example Corp",
            "companyNumber": "123456789",
            "companyStatus": "Active",
            "links": {
                "company": "https://example.com/company/123456789"
            },
            "locality": "Cityville"
        },
        {
            "companyName": "Sample Ltd",
            "companyNumber": "987654321",
            "companyStatus": "Dissolved",
            "links": {
                "company": "https://example.com/company/987654321"
            },
            "locality": "Townsville"
        }
    ],
    "kind": "response",
    "links": {
        "self": "https://example.com/companies"
    }
}
```
