Skip to main content
Get all accessible client lists with optional filtering.
External DocumentationTo learn more, visit the Akamai Client List documentation.

​
Basic Parameters

ParameterDescription
Include DeprecatedSelect to include deprecated client lists in the response.
Include ItemsSelect to include client list entries in the response.
Include Network ListSelect to include network lists in the response.
NameFilter results by a list’s name. Must be the exact name of the client list.
PageThe page number to retrieve (starts from 0).
Page SizeThe maximum number of items to retrieve per page.
Return All PagesAutomatically fetch all resources, page by page.
SearchA text filter to match against all client list values.
SortSort the retrieved collection of client lists by property and order - ASC or DESC.

Format: caseSensitiveFieldName:DIRECTION

Examples:
* updateDate:ASC
* expirationDate:DESC
TypeFilter results by a list’s type.

​
Advanced Parameters

ParameterDescription
Account Switch KeyAn account switch key to execute the operation on behalf of a different account.

​
Example Output

{
	"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
Workflow LibraryPreview this Workflow on desktop