> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Client Lists

Get all accessible client lists with optional filtering.

<Note>
  External Documentation

  To learn more, visit the [Akamai Client List documentation](https://techdocs.akamai.com/client-lists/reference/get-lists).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter            | Description                                                                                                                                                                                                              |
  | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | Include Deprecated   | Select to include deprecated client lists in the response.                                                                                                                                                               |
  | Include Items        | Select to include client list entries in the response.                                                                                                                                                                   |
  | Include Network List | Select to include network lists in the response.                                                                                                                                                                         |
  | Name                 | Filter results by a list's name. Must be the exact name of the client list.                                                                                                                                              |
  | Page                 | The page number to retrieve (starts from 0).                                                                                                                                                                             |
  | Page Size            | The maximum number of items to retrieve per page.                                                                                                                                                                        |
  | Return All Pages     | Automatically fetch all resources, page by page.                                                                                                                                                                         |
  | Search               | A text filter to match against all client list values.                                                                                                                                                                   |
  | Sort                 | Sort the retrieved collection of client lists by property and order - `ASC` or `DESC`.<br /><br />Format: `caseSensitiveFieldName:DIRECTION`<br /><br />Examples:<br />\* `updateDate:ASC`<br />\* `expirationDate:DESC` |
  | Type                 | Filter results by a list's type.                                                                                                                                                                                         |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter          | Description                                                                      |
  | ------------------ | -------------------------------------------------------------------------------- |
  | Account Switch Key | An account switch key to execute the operation on behalf of a different account. |
</div>

## Example Output

```json theme={"dark"}
{
	"content": [
		{
			"contractId": "K-0N7RAK71",
			"createDate": "2023-04-05T18:20:42.090+00:00",
			"createdBy": "jsmith",
			"deprecated": false,
			"groupId": 32145,
			"groupName": "Acme IT Group",
			"items": [
				{
					"createDate": "2023-04-05T18:20:42.892+00:00",
					"createdBy": "jkowalski",
					"description": "Canada - North America",
					"expirationDate": "2023-12-31T23:59:19.700+00:00",
					"productionStatus": "INACTIVE",
					"stagingStatus": "INACTIVE",
					"tags": [
						"allowlist1"
					],
					"type": "GEO",
					"updateDate": "2023-04-05T18:20:42.892+00:00",
					"updatedBy": "mrossi",
					"value": "CA"
				}
			],
			"itemsCount": 2,
			"listId": "12345_NORTHAMERICAGEOALLOWLIST",
			"listType": "CL",
			"name": "NorthAmericaGeoAllowlist",
			"notes": "GEO code allowlist",
			"productionActivationStatus": "INACTIVE",
			"productionActiveVersion": 0,
			"readOnly": false,
			"shared": false,
			"stagingActivationStatus": "INACTIVE",
			"stagingActiveVersion": 0,
			"tags": [],
			"type": "GEO",
			"updateDate": "2023-04-05T18:20:42.090+00:00",
			"updatedBy": "adevi",
			"version": 1
		}
	],
	"page": 0,
	"pageSize": 10,
	"totalElements": 1,
	"totalPages": 1
}
```

## Workflow Library Example

[List Client Lists with Akamai Client List and Send Results Via Email](https://library.blinkops.com/workflows/list-client-lists-with-akamai-client-list-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-client-lists-with-akamai-client-list-and-send-results-via-email/canvas" />
</div>
