Skip to content

List contacts in a list

client.List.ListContacts(ctx, listID, query) (*ListListContactsResponse, error)
GET/v1/lists/{listId}/contacts

Returns a paginated list of contacts that belong to the specified list. Results are sorted by when the record was created in Lightfield (createdAt), newest first. Each page holds only the records you can currently read, so a page can contain fewer records than limit, or none, while more remain, and totalCount can include records you can no longer read. To read every record, keep advancing offset by limit until it reaches totalCount; do not stop at a short or empty page.

Required scopes: lists:read and contacts:read

Rate limit category: Search

ParametersExpand Collapse
listID string

Unique identifier of the list.

query ListListContactsParams
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 ListListContactsResponse struct{…}
Data []ListListContactsResponseData

Array of entity objects for the current page.

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ListListContactsResponseDataField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value ListListContactsResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ListListContactsResponseDataFieldValueArray []string
type ListListContactsResponseDataFieldValueAddress 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 ListListContactsResponseDataFieldValueFullName 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 ListListContactsResponseDataFieldValueTypeAddress ListListContactsResponseDataFieldValueType = "ADDRESS"
const ListListContactsResponseDataFieldValueTypeCheckbox ListListContactsResponseDataFieldValueType = "CHECKBOX"
const ListListContactsResponseDataFieldValueTypeCurrency ListListContactsResponseDataFieldValueType = "CURRENCY"
const ListListContactsResponseDataFieldValueTypeDate ListListContactsResponseDataFieldValueType = "DATE"
const ListListContactsResponseDataFieldValueTypeDatetime ListListContactsResponseDataFieldValueType = "DATETIME"
const ListListContactsResponseDataFieldValueTypeEmail ListListContactsResponseDataFieldValueType = "EMAIL"
const ListListContactsResponseDataFieldValueTypeFullName ListListContactsResponseDataFieldValueType = "FULL_NAME"
const ListListContactsResponseDataFieldValueTypeMarkdown ListListContactsResponseDataFieldValueType = "MARKDOWN"
const ListListContactsResponseDataFieldValueTypeMultiSelect ListListContactsResponseDataFieldValueType = "MULTI_SELECT"
const ListListContactsResponseDataFieldValueTypeNumber ListListContactsResponseDataFieldValueType = "NUMBER"
const ListListContactsResponseDataFieldValueTypeSingleSelect ListListContactsResponseDataFieldValueType = "SINGLE_SELECT"
const ListListContactsResponseDataFieldValueTypeSocialHandle ListListContactsResponseDataFieldValueType = "SOCIAL_HANDLE"
const ListListContactsResponseDataFieldValueTypeTelephone ListListContactsResponseDataFieldValueType = "TELEPHONE"
const ListListContactsResponseDataFieldValueTypeText ListListContactsResponseDataFieldValueType = "TEXT"
const ListListContactsResponseDataFieldValueTypeURL ListListContactsResponseDataFieldValueType = "URL"
const ListListContactsResponseDataFieldValueTypeHTML ListListContactsResponseDataFieldValueType = "HTML"
Relationships map[string, ListListContactsResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions ListListContactsResponseDataRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination ListListContactsResponseDataRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ListListContactsResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne ListListContactsResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ListListContactsResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany ListListContactsResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ListListContactsResponseDataRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const ListListContactsResponseDataRelationshipDirectionsAsSourceCardinalityHasOne ListListContactsResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ListListContactsResponseDataRelationshipDirectionsAsSourceCardinalityHasMany ListListContactsResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0
maximum9007199254740991

List contacts in a list

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"),
  )
  listListContactsResponse, err := client.List.ListContacts(
    context.TODO(),
    "listId",
    githubcomlightfldlightfieldgo.ListListContactsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", listListContactsResponse.Data)
}
{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}
Returns Examples
{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}