Skip to content
Lightfield Lightfield
API Reference
List

List lists

list.list(ListListParams**kwargs) -> ListListResponse
GET/v1/lists

Returns a paginated list of lists. Use offset and limit to paginate through results. See List endpoints for more information about pagination.

Required scope: lists:read

Rate limit category: Search

ParametersExpand Collapse
limit: Optional[int]

Maximum number of records to return. Defaults to 25, maximum 25.

minimum1
maximum25
offset: Optional[int]

Number of records to skip for pagination. Defaults to 0.

minimum0
maximum9007199254740991
ReturnsExpand Collapse
class ListListResponse: …
data: List[Data]

Array of list objects for the current page.

id: str

Unique identifier for the list.

created_at: str

ISO 8601 timestamp of when the list was created.

fields: Dict[str, DataFields]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).

value: Optional[DataFieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class DataFieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class DataFieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]

The data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
object: str

The object type, always "list".

total_count: int

Total number of lists matching the query.

minimum0
maximum9007199254740991

List lists

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
list_list_response = client.list.list()
print(list_list_response.data)
{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink"
    }
  ],
  "object": "object",
  "totalCount": 0
}
Returns Examples
{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink"
    }
  ],
  "object": "object",
  "totalCount": 0
}