# List company entities

> Returns a paginated list of company entities

`GET https://api.light.inc/v1/entities`

## Note

Without a filter , inactive entities are hidden (the default is status:in:ACTIVE HIDDEN ). Any filter you send replaces that default entirely , so filter=code:eq:001 will also return an INACTIVE entity — add status:ne:INACTIVE yourself when combining filters. HIDDEN entities are hidden in the app but usable. Default order is the app's own ordering ( sortPosition:asc ), not name or code . includeCardCustomer has no effect on the response body.

## Authorization

- API key
- Bearer token

See https://light.inc/docs/getting-started/authentication.

## Query parameters

- `sort` (string) — Sort string in the format field:direction . To provide multiple sort fields, separate them with commas. Available directions: asc , desc . Available fields: code , createdAt , displayName , localCurrency , name , sortPosition , status , vatNumber .
- `filter` (string) — Filter string in the format field:operator:value . To provide multiple filters, separate them with commas. Available operators: eq , ne , in , not_in , gt , gte , lt , lte . - For in and not_in operators, provide multiple values separated by the pipe character ( ). Available fields: id , code , name , displayName , country , status , createdAt , updatedAt .
- `limit` (integer, int32) — Maximum number of items to return. Default is 50, maximum is 200.
- `offset` (integer, int64) — Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.
- `cursor` (string) — The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.
- `includeCardCustomer` (boolean)


## Response

- `records.address.city` — City.
- `records.address.state` — State or region, where the country uses one.
- `records.address.zipcode` — Postal code.
- `records.address.street` — First address line.
- `records.address.street2` — Second address line.

```json
{
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "string",
      "parentCompanyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "localCurrency": "USD",
      "displayName": "string",
      "vatNumber": "string",
      "name": "string",
      "address": {
        "country": "AC",
        "city": "string",
        "state": "string",
        "zipcode": "string",
        "street": "string",
        "street2": "string"
      },
      "status": "ACTIVE",
      "seedInvoiceNumber": 100000,
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "hasMore": true,
  "total": 100000,
  "nextCursor": "string",
  "prevCursor": "string"
}
```

Values above are generated from the schema: the shapes and types are real, the values are placeholders.

## Code

```bash
curl -X GET "https://api.light.inc/v1/entities" \
  -H "Authorization: Basic YOUR_API_KEY"
```

---

Full page: https://light.inc/docs/api-reference/v1--entities/list-company-entities · Index: https://light.inc/docs/llms.txt