## Retrieve all labels

`api_gateway.labels.list(LabelListParams**kwargs)  -> SyncV4PagePaginationArray[LabelListResponse]`

**get** `/zones/{zone_id}/api_gateway/labels`

Retrieve all labels

### Parameters

- `zone_id: str`

  Identifier.

- `direction: Optional[Literal["asc", "desc"]]`

  Direction to order results.

  - `"asc"`

  - `"desc"`

- `filter: Optional[str]`

  Filter for labels where the name or description matches using substring match

- `order: Optional[Literal["name", "description", "created_at", 2 more]]`

  Field to order by

  - `"name"`

  - `"description"`

  - `"created_at"`

  - `"last_updated"`

  - `"mapped_resources.operations"`

- `page: Optional[int]`

  Page number of paginated results.

- `per_page: Optional[int]`

  Maximum number of results per page.

- `source: Optional[Literal["user", "managed"]]`

  Filter for labels with source

  - `"user"`

  - `"managed"`

- `with_mapped_resource_counts: Optional[bool]`

  Include `mapped_resources` for each label

### Returns

- `class LabelListResponse: …`

  - `created_at: datetime`

  - `description: str`

    The description of the label

  - `last_updated: datetime`

  - `metadata: object`

    Metadata for the label

  - `name: str`

    The name of the label

  - `source: Literal["user", "managed"]`

    * `user` - label is owned by the user
    * `managed` - label is owned by cloudflare

    - `"user"`

    - `"managed"`

  - `mapped_resources: Optional[object]`

    Provides counts of what resources are linked to this label

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.api_gateway.labels.list(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.created_at)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "created_at": "2014-01-01T05:20:00.12345Z",
      "description": "All endpoints that deal with logins",
      "last_updated": "2014-01-01T05:20:00.12345Z",
      "metadata": {
        "foo": "bar"
      },
      "name": "login",
      "source": "user",
      "mapped_resources": {
        "operations": 29
      }
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```