List lists

client.List.List(ctx, query) (*ListListResponse, error)

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

query ListListParams

Limit param.Field[int64]Optional

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

minimum1

maximum25

Offset param.Field[int64]Optional

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

minimum0

maximum9007199254740991

ReturnsExpand Collapse

type ListListResponse struct{…}

Data []ListListResponseData

Array of list objects for the current page.

ID string

Unique identifier for the list.

CreatedAt string

ISO 8601 timestamp of when the list was created.

Fields map[string, ListListResponseDataField]

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

Value ListListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ListListResponseDataFieldValueArray []string

type ListListResponseDataFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

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

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type ListListResponseDataFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const ListListResponseDataFieldValueTypeAddress ListListResponseDataFieldValueType = "ADDRESS"

const ListListResponseDataFieldValueTypeCheckbox ListListResponseDataFieldValueType = "CHECKBOX"

const ListListResponseDataFieldValueTypeCurrency ListListResponseDataFieldValueType = "CURRENCY"

const ListListResponseDataFieldValueTypeDatetime ListListResponseDataFieldValueType = "DATETIME"

const ListListResponseDataFieldValueTypeEmail ListListResponseDataFieldValueType = "EMAIL"

const ListListResponseDataFieldValueTypeFullName ListListResponseDataFieldValueType = "FULL_NAME"

const ListListResponseDataFieldValueTypeMarkdown ListListResponseDataFieldValueType = "MARKDOWN"

const ListListResponseDataFieldValueTypeMultiSelect ListListResponseDataFieldValueType = "MULTI_SELECT"

const ListListResponseDataFieldValueTypeNumber ListListResponseDataFieldValueType = "NUMBER"

const ListListResponseDataFieldValueTypeSingleSelect ListListResponseDataFieldValueType = "SINGLE_SELECT"

const ListListResponseDataFieldValueTypeSocialHandle ListListResponseDataFieldValueType = "SOCIAL_HANDLE"

const ListListResponseDataFieldValueTypeTelephone ListListResponseDataFieldValueType = "TELEPHONE"

const ListListResponseDataFieldValueTypeText ListListResponseDataFieldValueType = "TEXT"

const ListListResponseDataFieldValueTypeURL ListListResponseDataFieldValueType = "URL"

HTTPLink string

URL to view the list in the Lightfield web app, or null.

Object string

The object type, always "list".

TotalCount int64

Total number of lists matching the query.

minimum0

maximum9007199254740991

List lists

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  listListResponse, err := client.List.List(context.TODO(), githubcomlightfldlightfieldgo.ListListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", listListResponse.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
}