# Get company list

`GET /api/v1/Outlets/{outletId}/Companies`

Core API · Companies · base URL `https://core-api.ancon.io` · auth: `Access-Token` header · docs: https://ancon.dev/api/core/companies/get-company-list

**Deprecated.**

Will no longer work after 2027-03-31 00:00, move over to user service instead.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outletId` | string (uuid) | yes |  |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Offset` | integer (int32) | no | Offset the result, defaults to 0 |
| `Limit` | integer (int32) | no | Limits how many items to get, defaults to 100 min 0, max 1000. |
| `Order` | string | no | Order the result. |
| `Search` | string | no |  |
| `Filter` | map<string, array<string>> | no | Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00 |

## Header parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `correlationId` | string | no | Correlation Id for the request |

## Responses

| Status | Description |
| --- | --- |
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |

### 200 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array<object> or null | no |  |
| `items[].id` | string (uuid) | no |  |
| `items[].name` | string or null | no |  |
| `items[].created` | string (date-time) | no |  |
| `items[].lastOrderedAt` | string (date-time) or null | no |  |
| `items[].invoiceCount` | integer (int32) | no |  |
| `items[].totalSpent` | number (double) | no |  |
| `items[].originatingOutletId` | string (uuid) or null | no |  |
| `items[].originatingOutletName` | string or null | no |  |
| `items[].originatingIntegrationType` | integer (int32) or null | no | Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `29`, `30`, `31`, `32`, `-2`, `-1`. |
| `meta` | object or null | no |  |
| `meta.count` | integer (int32) | no |  |
| `meta.offset` | integer (int32) | no |  |

#### Example

```json
{
  "items": [
    {
      "id": "307d2350-9fa6-492e-b7bd-94b88eff32e0",
      "name": "Nice food AB",
      "created": "2026-10-23T15:43:52.9844939Z",
      "lastOrderedAt": "2026-10-23T09:43:52.9844941Z",
      "invoiceCount": 41,
      "totalSpent": 12423.23,
      "originatingOutletId": null,
      "originatingOutletName": null,
      "originatingIntegrationType": null
    },
    {
      "id": "6ba48f82-3b23-4499-ab02-b0557f270a3c",
      "name": "Okay food AB",
      "created": "2026-10-23T15:43:52.9844968Z",
      "lastOrderedAt": "2026-10-23T09:43:52.9844968Z",
      "invoiceCount": 23,
      "totalSpent": 5003,
      "originatingOutletId": null,
      "originatingOutletName": null,
      "originatingIntegrationType": null
    }
  ],
  "meta": {
    "count": 2,
    "offset": 0
  }
}
```

### 400 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |
| `errorCode` | string (uuid) | no |  |
| `additionalData` | any or null | no |  |

#### Delivery request is not valid

```json
{
  "message": "Delivery information is not valid!",
  "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a",
  "additionalData": null
}
```

### 401 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |

#### Example (from schema)

```json
{
  "message": "string"
}
```

### 404 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |
| `errorCode` | string (uuid) | no |  |

#### Example (from schema)

```json
{
  "message": "string",
  "errorCode": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

## Example request

```bash
curl -X GET "https://core-api.ancon.io/api/v1/Outlets/{outletId}/Companies" \
  -H "Access-Token: $ANCON_TOKEN"
```