## 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.

**[Required scopes](/using-the-api/scopes/):** `lists:read` and `contacts:read`

**[Rate limit category](/using-the-api/rate-limits/):** Search

### Parameters

- `listID string`

  Unique identifier of the list.

- `query ListListContactsParams`

  - `Limit param.Field[int64]`

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

  - `Offset param.Field[int64]`

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

### Returns

- `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.

        - `string`

        - `float64`

        - `bool`

        - `type ListListContactsResponseDataFieldValueArray []string`

        - `type ListListContactsResponseDataFieldValueAddress struct{…}`

          - `City string`

            City name.

          - `Country string`

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

          - `Latitude float64`

            Latitude coordinate.

          - `Longitude float64`

            Longitude coordinate.

          - `PostalCode string`

            Postal or ZIP code.

          - `State string`

            State or province.

          - `Street string`

            Street address line 1.

          - `Street2 string`

            Street address line 2.

        - `type ListListContactsResponseDataFieldValueFullName struct{…}`

          - `FirstName string`

            The contact's first name.

          - `LastName string`

            The contact's last name.

      - `ValueType string`

        The data type of the field.

        - `const ListListContactsResponseDataFieldValueTypeAddress ListListContactsResponseDataFieldValueType = "ADDRESS"`

        - `const ListListContactsResponseDataFieldValueTypeCheckbox ListListContactsResponseDataFieldValueType = "CHECKBOX"`

        - `const ListListContactsResponseDataFieldValueTypeCurrency ListListContactsResponseDataFieldValueType = "CURRENCY"`

        - `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"`

    - `HTTPLink string`

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

    - `Relationships map[string, ListListContactsResponseDataRelationship]`

      Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

      - `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.

    - `UpdatedAt string`

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

    - `ExternalID string`

      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.

### Example

```go
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)
}
```

#### Response

```json
{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ]
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}
```