Klaviyo API

Getting access, Developing, Testing

Back to Klaviyo

Get Lists

Get all lists in an account.\nFilter to request a subset of all lists. Lists can be filtered by id, name, created, and updated fields.\nReturns a maximum of 10 results per page.

Rate limits:
Burst: 10/s
Steady: 150/m\n\nScopes:\nList Read

Input

type: object properties: parameters: type: object properties: fields[list]: type: array items: type: string enum: - name - created - updated description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets filter: type: string description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than` page[cursor]: type: string description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination revision: type: string default: '2023-02-22' description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])' required: - revision title: Parameters

Output

type: object required: - data - links properties: data: type: array items: type: object required: - type - id - attributes - links properties: type: type: string enum: - list id: type: string example: Y6nRLr description: >- Primary key that uniquely identifies this list. Generated by Klaviyo. attributes: type: object properties: name: type: string example: Newsletter description: A helpful name to label the list created: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) updated: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) links: type: object required: - self properties: self: type: string format: uri links: type: object required: - self properties: self: type: string format: uri first: type: string format: uri last: type: string format: uri prev: type: string format: uri next: type: string format: uri