## List custom object records

`client.Object.List(ctx, entitySlug, query) (*ObjectListResponse, error)`

**get** `/v1/objects/{entitySlug}`

Returns a paginated list of records for the specified custom object type. Use `offset` and `limit` to paginate through results, and `$field` query parameters to filter. See <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about <u>[pagination](/using-the-api/list-endpoints/#pagination)</u> and <u>[filtering](/using-the-api/list-endpoints/#filtering)</u>.

### Parameters

- `entitySlug string`

  The slug of the custom object type.

- `query ObjectListParams`

  - `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 ObjectListResponse struct{…}`

  - `Data []ObjectListResponseData`

    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, ObjectListResponseDataField]`

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

      - `Value ObjectListResponseDataFieldValueUnion`

        The field value, or null if unset.

        - `string`

        - `float64`

        - `bool`

        - `type ObjectListResponseDataFieldValueArray []string`

        - `type ObjectListResponseDataFieldValueAddress 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 ObjectListResponseDataFieldValueFullName struct{…}`

          - `FirstName string`

            The contact's first name.

          - `LastName string`

            The contact's last name.

      - `ValueType string`

        The data type of the field.

        - `const ObjectListResponseDataFieldValueTypeAddress ObjectListResponseDataFieldValueType = "ADDRESS"`

        - `const ObjectListResponseDataFieldValueTypeCheckbox ObjectListResponseDataFieldValueType = "CHECKBOX"`

        - `const ObjectListResponseDataFieldValueTypeCurrency ObjectListResponseDataFieldValueType = "CURRENCY"`

        - `const ObjectListResponseDataFieldValueTypeDatetime ObjectListResponseDataFieldValueType = "DATETIME"`

        - `const ObjectListResponseDataFieldValueTypeEmail ObjectListResponseDataFieldValueType = "EMAIL"`

        - `const ObjectListResponseDataFieldValueTypeFullName ObjectListResponseDataFieldValueType = "FULL_NAME"`

        - `const ObjectListResponseDataFieldValueTypeMarkdown ObjectListResponseDataFieldValueType = "MARKDOWN"`

        - `const ObjectListResponseDataFieldValueTypeMultiSelect ObjectListResponseDataFieldValueType = "MULTI_SELECT"`

        - `const ObjectListResponseDataFieldValueTypeNumber ObjectListResponseDataFieldValueType = "NUMBER"`

        - `const ObjectListResponseDataFieldValueTypeSingleSelect ObjectListResponseDataFieldValueType = "SINGLE_SELECT"`

        - `const ObjectListResponseDataFieldValueTypeSocialHandle ObjectListResponseDataFieldValueType = "SOCIAL_HANDLE"`

        - `const ObjectListResponseDataFieldValueTypeTelephone ObjectListResponseDataFieldValueType = "TELEPHONE"`

        - `const ObjectListResponseDataFieldValueTypeText ObjectListResponseDataFieldValueType = "TEXT"`

        - `const ObjectListResponseDataFieldValueTypeURL ObjectListResponseDataFieldValueType = "URL"`

        - `const ObjectListResponseDataFieldValueTypeHTML ObjectListResponseDataFieldValueType = "HTML"`

    - `HTTPLink string`

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

    - `Relationships map[string, ObjectListResponseDataRelationship]`

      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"),
  )
  objectListResponse, err := client.Object.List(
    context.TODO(),
    "entitySlug",
    githubcomlightfldlightfieldgo.ObjectListParams{

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