Skip to main content
Get a specific version of an activated client list.
External DocumentationTo learn more, visit the Akamai Client List documentation.

​
Basic Parameters

ParameterDescription
List IDThe ID of the client list to retrieve the snapshot for.
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 version values.
SortSort the retrieved collection of client lists by property and order - ASC or DESC.

Format: caseSensitiveFieldName:DIRECTION

Examples:
* updateDate:ASC
* expirationDate:DESC
VersionThe version number of the client list snapshot to retrieve.

​
Advanced Parameters

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

​
Example Output

{
	"content": [
		{
			"createDate": "2023-04-05T18:20:42.892+00:00",
			"createdBy": "tyamada",
			"description": "Canada - North America",
			"expirationDate": "2023-12-31T23:59:19.700+00:00",
			"tags": [
				"allowlist1"
			],
			"type": "GEO",
			"updateDate": "2023-04-05T18:20:42.892+00:00",
			"updatedBy": "tyamada",
			"value": "CA"
		},
		{
			"createDate": "2023-04-05T18:20:42.892+00:00",
			"createdBy": "adevi",
			"description": "Mexico - North America",
			"expirationDate": "2023-12-31T23:59:19.700+00:00",
			"tags": [
				"allowlist1"
			],
			"type": "GEO",
			"updateDate": "2023-04-05T18:20:42.892+00:00",
			"updatedBy": "szhang",
			"value": "MX"
		}
	],
	"page": 0,
	"pageSize": 10,
	"totalElements": 2,
	"totalPages": 1
}

​
Workflow Library Example

Get Client List Snapshot with Akamai Client List and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop