## List custom object records

`object.list(strentity_slug, ObjectListParams**kwargs)  -> ObjectListResponse`

**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

- `entity_slug: str`

  The slug of the custom object type.

- `limit: Optional[int]`

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

- `offset: Optional[int]`

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

### Returns

- `class ObjectListResponse: …`

  - `data: List[Data]`

    Array of entity objects for the current page.

    - `id: str`

      Unique identifier for the entity.

    - `created_at: str`

      ISO 8601 timestamp of when the entity was created.

    - `fields: Dict[str, DataFields]`

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

      - `value: Optional[DataFieldsValue]`

        The field value, or null if unset.

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

        - `"ADDRESS"`

        - `"CHECKBOX"`

        - `"CURRENCY"`

        - `"DATETIME"`

        - `"EMAIL"`

        - `"FULL_NAME"`

        - `"MARKDOWN"`

        - `"MULTI_SELECT"`

        - `"NUMBER"`

        - `"SINGLE_SELECT"`

        - `"SOCIAL_HANDLE"`

        - `"TELEPHONE"`

        - `"TEXT"`

        - `"URL"`

    - `http_link: Optional[str]`

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

    - `relationships: Dict[str, DataRelationships]`

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

      - `cardinality: str`

        Whether the relationship is `has_one` or `has_many`.

      - `object_type: str`

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

      - `values: List[str]`

        IDs of the related entities.

    - `updated_at: Optional[str]`

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

    - `external_id: Optional[str]`

      External identifier for the entity, or null if unset.

  - `object: str`

    The object type, always `"list"`.

  - `total_count: int`

    Total number of entities matching the query.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
object_list_response = client.object.list(
    entity_slug="entitySlug",
)
print(object_list_response.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
}
```