# List ## Create a list `client.List.New(ctx, body) (*ListCreateResponse, error)` **post** `/v1/lists` Creates a new list. The `$name` and `$objectType` fields are required. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `lists:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `body ListNewParams` - `Fields param.Field[ListNewParamsFields]` Field values for the new list. Required: `$name` (string) and `$objectType`. - `Name string` Display name of the list. - `ObjectType string` The type of entities this list contains. One of `account`, `contact`, or `opportunity`. - `const ListNewParamsFieldsObjectTypeAccount ListNewParamsFieldsObjectType = "account"` - `const ListNewParamsFieldsObjectTypeContact ListNewParamsFieldsObjectType = "contact"` - `const ListNewParamsFieldsObjectTypeOpportunity ListNewParamsFieldsObjectType = "opportunity"` - `Relationships param.Field[ListNewParamsRelationshipsUnion]` Relationships to set on the new list. - `type ListNewParamsRelationshipsAccounts struct{…}` - `Accounts ListNewParamsRelationshipsAccountsAccountsUnion` Account ID(s) to add as initial members. List `$objectType` must be `account`. - `string` - `type ListNewParamsRelationshipsAccountsAccountsArray []string` - `type ListNewParamsRelationshipsContacts struct{…}` - `Contacts ListNewParamsRelationshipsContactsContactsUnion` Contact ID(s) to add as initial members. List `$objectType` must be `contact`. - `string` - `type ListNewParamsRelationshipsContactsContactsArray []string` - `type ListNewParamsRelationshipsOpportunities struct{…}` - `Opportunities ListNewParamsRelationshipsOpportunitiesOpportunitiesUnion` Opportunity ID(s) to add as initial members. List `$objectType` must be `opportunity`. - `string` - `type ListNewParamsRelationshipsOpportunitiesOpportunitiesArray []string` ### Returns - `type ListCreateResponse struct{…}` - `ID string` Unique identifier for the list. - `CreatedAt string` ISO 8601 timestamp of when the list was created. - `Fields map[string, ListCreateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `Value ListCreateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListCreateResponseFieldValueArray []string` - `type ListCreateResponseFieldValueAddress 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 ListCreateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListCreateResponseFieldValueTypeAddress ListCreateResponseFieldValueType = "ADDRESS"` - `const ListCreateResponseFieldValueTypeCheckbox ListCreateResponseFieldValueType = "CHECKBOX"` - `const ListCreateResponseFieldValueTypeCurrency ListCreateResponseFieldValueType = "CURRENCY"` - `const ListCreateResponseFieldValueTypeDatetime ListCreateResponseFieldValueType = "DATETIME"` - `const ListCreateResponseFieldValueTypeEmail ListCreateResponseFieldValueType = "EMAIL"` - `const ListCreateResponseFieldValueTypeFullName ListCreateResponseFieldValueType = "FULL_NAME"` - `const ListCreateResponseFieldValueTypeMarkdown ListCreateResponseFieldValueType = "MARKDOWN"` - `const ListCreateResponseFieldValueTypeMultiSelect ListCreateResponseFieldValueType = "MULTI_SELECT"` - `const ListCreateResponseFieldValueTypeNumber ListCreateResponseFieldValueType = "NUMBER"` - `const ListCreateResponseFieldValueTypeSingleSelect ListCreateResponseFieldValueType = "SINGLE_SELECT"` - `const ListCreateResponseFieldValueTypeSocialHandle ListCreateResponseFieldValueType = "SOCIAL_HANDLE"` - `const ListCreateResponseFieldValueTypeTelephone ListCreateResponseFieldValueType = "TELEPHONE"` - `const ListCreateResponseFieldValueTypeText ListCreateResponseFieldValueType = "TEXT"` - `const ListCreateResponseFieldValueTypeURL ListCreateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the list in the Lightfield web app, or null. ### 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"), ) listCreateResponse, err := client.List.New(context.TODO(), githubcomlightfldlightfieldgo.ListNewParams{ Fields: githubcomlightfldlightfieldgo.ListNewParamsFields{ Name: "$name", ObjectType: "account", }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", listCreateResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ``` ## Update a list `client.List.Update(ctx, id, body) (*ListUpdateResponse, error)` **post** `/v1/lists/{id}` Updates an existing list by ID. Only included fields are modified. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `lists:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id string` Unique identifier of the list to update. - `body ListUpdateParams` - `Fields param.Field[ListUpdateParamsFields]` Field values to update — only provided fields are modified; omitted fields are left unchanged. - `Name string` Display name of the list. - `Relationships param.Field[ListUpdateParamsRelationshipsUnion]` Relationship operations. Use the key matching the list's `$objectType` (e.g. `$accounts` for an account list). - `type ListUpdateParamsRelationshipsAccounts struct{…}` - `Accounts ListUpdateParamsRelationshipsAccountsAccounts` Add/remove accounts. List `$objectType` must be `account`. - `Add ListUpdateParamsRelationshipsAccountsAccountsAddUnion` Entity ID(s) to add to the list. - `string` - `type ListUpdateParamsRelationshipsAccountsAccountsAddArray []string` - `Remove ListUpdateParamsRelationshipsAccountsAccountsRemoveUnion` Entity ID(s) to remove from the list. - `string` - `type ListUpdateParamsRelationshipsAccountsAccountsRemoveArray []string` - `type ListUpdateParamsRelationshipsContacts struct{…}` - `Contacts ListUpdateParamsRelationshipsContactsContacts` Add/remove contacts. List `$objectType` must be `contact`. - `Add ListUpdateParamsRelationshipsContactsContactsAddUnion` Entity ID(s) to add to the list. - `string` - `type ListUpdateParamsRelationshipsContactsContactsAddArray []string` - `Remove ListUpdateParamsRelationshipsContactsContactsRemoveUnion` Entity ID(s) to remove from the list. - `string` - `type ListUpdateParamsRelationshipsContactsContactsRemoveArray []string` - `type ListUpdateParamsRelationshipsOpportunities struct{…}` - `Opportunities ListUpdateParamsRelationshipsOpportunitiesOpportunities` Add/remove opportunities. List `$objectType` must be `opportunity`. - `Add ListUpdateParamsRelationshipsOpportunitiesOpportunitiesAddUnion` Entity ID(s) to add to the list. - `string` - `type ListUpdateParamsRelationshipsOpportunitiesOpportunitiesAddArray []string` - `Remove ListUpdateParamsRelationshipsOpportunitiesOpportunitiesRemoveUnion` Entity ID(s) to remove from the list. - `string` - `type ListUpdateParamsRelationshipsOpportunitiesOpportunitiesRemoveArray []string` ### Returns - `type ListUpdateResponse struct{…}` - `ID string` Unique identifier for the list. - `CreatedAt string` ISO 8601 timestamp of when the list was created. - `Fields map[string, ListUpdateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `Value ListUpdateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListUpdateResponseFieldValueArray []string` - `type ListUpdateResponseFieldValueAddress 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 ListUpdateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListUpdateResponseFieldValueTypeAddress ListUpdateResponseFieldValueType = "ADDRESS"` - `const ListUpdateResponseFieldValueTypeCheckbox ListUpdateResponseFieldValueType = "CHECKBOX"` - `const ListUpdateResponseFieldValueTypeCurrency ListUpdateResponseFieldValueType = "CURRENCY"` - `const ListUpdateResponseFieldValueTypeDatetime ListUpdateResponseFieldValueType = "DATETIME"` - `const ListUpdateResponseFieldValueTypeEmail ListUpdateResponseFieldValueType = "EMAIL"` - `const ListUpdateResponseFieldValueTypeFullName ListUpdateResponseFieldValueType = "FULL_NAME"` - `const ListUpdateResponseFieldValueTypeMarkdown ListUpdateResponseFieldValueType = "MARKDOWN"` - `const ListUpdateResponseFieldValueTypeMultiSelect ListUpdateResponseFieldValueType = "MULTI_SELECT"` - `const ListUpdateResponseFieldValueTypeNumber ListUpdateResponseFieldValueType = "NUMBER"` - `const ListUpdateResponseFieldValueTypeSingleSelect ListUpdateResponseFieldValueType = "SINGLE_SELECT"` - `const ListUpdateResponseFieldValueTypeSocialHandle ListUpdateResponseFieldValueType = "SOCIAL_HANDLE"` - `const ListUpdateResponseFieldValueTypeTelephone ListUpdateResponseFieldValueType = "TELEPHONE"` - `const ListUpdateResponseFieldValueTypeText ListUpdateResponseFieldValueType = "TEXT"` - `const ListUpdateResponseFieldValueTypeURL ListUpdateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the list in the Lightfield web app, or null. ### 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"), ) listUpdateResponse, err := client.List.Update( context.TODO(), "id", githubcomlightfldlightfieldgo.ListUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", listUpdateResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ``` ## Retrieve a list `client.List.Get(ctx, id) (*ListRetrieveResponse, error)` **get** `/v1/lists/{id}` Retrieves a single list by its ID. **[Required scope](/using-the-api/scopes/):** `lists:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id string` Unique identifier of the list to retrieve. ### Returns - `type ListRetrieveResponse struct{…}` - `ID string` Unique identifier for the list. - `CreatedAt string` ISO 8601 timestamp of when the list was created. - `Fields map[string, ListRetrieveResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `Value ListRetrieveResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListRetrieveResponseFieldValueArray []string` - `type ListRetrieveResponseFieldValueAddress 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 ListRetrieveResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListRetrieveResponseFieldValueTypeAddress ListRetrieveResponseFieldValueType = "ADDRESS"` - `const ListRetrieveResponseFieldValueTypeCheckbox ListRetrieveResponseFieldValueType = "CHECKBOX"` - `const ListRetrieveResponseFieldValueTypeCurrency ListRetrieveResponseFieldValueType = "CURRENCY"` - `const ListRetrieveResponseFieldValueTypeDatetime ListRetrieveResponseFieldValueType = "DATETIME"` - `const ListRetrieveResponseFieldValueTypeEmail ListRetrieveResponseFieldValueType = "EMAIL"` - `const ListRetrieveResponseFieldValueTypeFullName ListRetrieveResponseFieldValueType = "FULL_NAME"` - `const ListRetrieveResponseFieldValueTypeMarkdown ListRetrieveResponseFieldValueType = "MARKDOWN"` - `const ListRetrieveResponseFieldValueTypeMultiSelect ListRetrieveResponseFieldValueType = "MULTI_SELECT"` - `const ListRetrieveResponseFieldValueTypeNumber ListRetrieveResponseFieldValueType = "NUMBER"` - `const ListRetrieveResponseFieldValueTypeSingleSelect ListRetrieveResponseFieldValueType = "SINGLE_SELECT"` - `const ListRetrieveResponseFieldValueTypeSocialHandle ListRetrieveResponseFieldValueType = "SOCIAL_HANDLE"` - `const ListRetrieveResponseFieldValueTypeTelephone ListRetrieveResponseFieldValueType = "TELEPHONE"` - `const ListRetrieveResponseFieldValueTypeText ListRetrieveResponseFieldValueType = "TEXT"` - `const ListRetrieveResponseFieldValueTypeURL ListRetrieveResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the list in the Lightfield web app, or null. ### 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"), ) listRetrieveResponse, err := client.List.Get(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", listRetrieveResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ``` ## 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](/using-the-api/list-endpoints/) for more information about pagination. **[Required scope](/using-the-api/scopes/):** `lists:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `query ListListParams` - `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 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. - `string` - `float64` - `bool` - `type ListListResponseDataFieldValueArray []string` - `type ListListResponseDataFieldValueAddress 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 ListListResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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. ### 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"), ) listListResponse, err := client.List.List(context.TODO(), githubcomlightfldlightfieldgo.ListListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", listListResponse.Data) } ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ], "object": "object", "totalCount": 0 } ``` ## List accounts in a list `client.List.ListAccounts(ctx, listID, query) (*ListListAccountsResponse, error)` **get** `/v1/lists/{listId}/accounts` Returns a paginated list of accounts that belong to the specified list. **[Required scopes](/using-the-api/scopes/):** `lists:read` and `accounts:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `listID string` Unique identifier of the list. - `query ListListAccountsParams` - `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 ListListAccountsResponse struct{…}` - `Data []ListListAccountsResponseData` 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, ListListAccountsResponseDataField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value ListListAccountsResponseDataFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListListAccountsResponseDataFieldValueArray []string` - `type ListListAccountsResponseDataFieldValueAddress 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 ListListAccountsResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListListAccountsResponseDataFieldValueTypeAddress ListListAccountsResponseDataFieldValueType = "ADDRESS"` - `const ListListAccountsResponseDataFieldValueTypeCheckbox ListListAccountsResponseDataFieldValueType = "CHECKBOX"` - `const ListListAccountsResponseDataFieldValueTypeCurrency ListListAccountsResponseDataFieldValueType = "CURRENCY"` - `const ListListAccountsResponseDataFieldValueTypeDatetime ListListAccountsResponseDataFieldValueType = "DATETIME"` - `const ListListAccountsResponseDataFieldValueTypeEmail ListListAccountsResponseDataFieldValueType = "EMAIL"` - `const ListListAccountsResponseDataFieldValueTypeFullName ListListAccountsResponseDataFieldValueType = "FULL_NAME"` - `const ListListAccountsResponseDataFieldValueTypeMarkdown ListListAccountsResponseDataFieldValueType = "MARKDOWN"` - `const ListListAccountsResponseDataFieldValueTypeMultiSelect ListListAccountsResponseDataFieldValueType = "MULTI_SELECT"` - `const ListListAccountsResponseDataFieldValueTypeNumber ListListAccountsResponseDataFieldValueType = "NUMBER"` - `const ListListAccountsResponseDataFieldValueTypeSingleSelect ListListAccountsResponseDataFieldValueType = "SINGLE_SELECT"` - `const ListListAccountsResponseDataFieldValueTypeSocialHandle ListListAccountsResponseDataFieldValueType = "SOCIAL_HANDLE"` - `const ListListAccountsResponseDataFieldValueTypeTelephone ListListAccountsResponseDataFieldValueType = "TELEPHONE"` - `const ListListAccountsResponseDataFieldValueTypeText ListListAccountsResponseDataFieldValueType = "TEXT"` - `const ListListAccountsResponseDataFieldValueTypeURL ListListAccountsResponseDataFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, ListListAccountsResponseDataRelationship]` 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"), ) listListAccountsResponse, err := client.List.ListAccounts( context.TODO(), "listId", githubcomlightfldlightfieldgo.ListListAccountsParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", listListAccountsResponse.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 } ``` ## 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 } ``` ## List opportunities in a list `client.List.ListOpportunities(ctx, listID, query) (*ListListOpportunitiesResponse, error)` **get** `/v1/lists/{listId}/opportunities` Returns a paginated list of opportunities that belong to the specified list. **[Required scopes](/using-the-api/scopes/):** `lists:read` and `opportunities:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `listID string` Unique identifier of the list. - `query ListListOpportunitiesParams` - `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 ListListOpportunitiesResponse struct{…}` - `Data []ListListOpportunitiesResponseData` 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, ListListOpportunitiesResponseDataField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value ListListOpportunitiesResponseDataFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListListOpportunitiesResponseDataFieldValueArray []string` - `type ListListOpportunitiesResponseDataFieldValueAddress 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 ListListOpportunitiesResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListListOpportunitiesResponseDataFieldValueTypeAddress ListListOpportunitiesResponseDataFieldValueType = "ADDRESS"` - `const ListListOpportunitiesResponseDataFieldValueTypeCheckbox ListListOpportunitiesResponseDataFieldValueType = "CHECKBOX"` - `const ListListOpportunitiesResponseDataFieldValueTypeCurrency ListListOpportunitiesResponseDataFieldValueType = "CURRENCY"` - `const ListListOpportunitiesResponseDataFieldValueTypeDatetime ListListOpportunitiesResponseDataFieldValueType = "DATETIME"` - `const ListListOpportunitiesResponseDataFieldValueTypeEmail ListListOpportunitiesResponseDataFieldValueType = "EMAIL"` - `const ListListOpportunitiesResponseDataFieldValueTypeFullName ListListOpportunitiesResponseDataFieldValueType = "FULL_NAME"` - `const ListListOpportunitiesResponseDataFieldValueTypeMarkdown ListListOpportunitiesResponseDataFieldValueType = "MARKDOWN"` - `const ListListOpportunitiesResponseDataFieldValueTypeMultiSelect ListListOpportunitiesResponseDataFieldValueType = "MULTI_SELECT"` - `const ListListOpportunitiesResponseDataFieldValueTypeNumber ListListOpportunitiesResponseDataFieldValueType = "NUMBER"` - `const ListListOpportunitiesResponseDataFieldValueTypeSingleSelect ListListOpportunitiesResponseDataFieldValueType = "SINGLE_SELECT"` - `const ListListOpportunitiesResponseDataFieldValueTypeSocialHandle ListListOpportunitiesResponseDataFieldValueType = "SOCIAL_HANDLE"` - `const ListListOpportunitiesResponseDataFieldValueTypeTelephone ListListOpportunitiesResponseDataFieldValueType = "TELEPHONE"` - `const ListListOpportunitiesResponseDataFieldValueTypeText ListListOpportunitiesResponseDataFieldValueType = "TEXT"` - `const ListListOpportunitiesResponseDataFieldValueTypeURL ListListOpportunitiesResponseDataFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, ListListOpportunitiesResponseDataRelationship]` 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"), ) listListOpportunitiesResponse, err := client.List.ListOpportunities( context.TODO(), "listId", githubcomlightfldlightfieldgo.ListListOpportunitiesParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", listListOpportunitiesResponse.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 } ``` ## Domain Types ### List Create Response - `type ListCreateResponse struct{…}` - `ID string` Unique identifier for the list. - `CreatedAt string` ISO 8601 timestamp of when the list was created. - `Fields map[string, ListCreateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `Value ListCreateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListCreateResponseFieldValueArray []string` - `type ListCreateResponseFieldValueAddress 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 ListCreateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListCreateResponseFieldValueTypeAddress ListCreateResponseFieldValueType = "ADDRESS"` - `const ListCreateResponseFieldValueTypeCheckbox ListCreateResponseFieldValueType = "CHECKBOX"` - `const ListCreateResponseFieldValueTypeCurrency ListCreateResponseFieldValueType = "CURRENCY"` - `const ListCreateResponseFieldValueTypeDatetime ListCreateResponseFieldValueType = "DATETIME"` - `const ListCreateResponseFieldValueTypeEmail ListCreateResponseFieldValueType = "EMAIL"` - `const ListCreateResponseFieldValueTypeFullName ListCreateResponseFieldValueType = "FULL_NAME"` - `const ListCreateResponseFieldValueTypeMarkdown ListCreateResponseFieldValueType = "MARKDOWN"` - `const ListCreateResponseFieldValueTypeMultiSelect ListCreateResponseFieldValueType = "MULTI_SELECT"` - `const ListCreateResponseFieldValueTypeNumber ListCreateResponseFieldValueType = "NUMBER"` - `const ListCreateResponseFieldValueTypeSingleSelect ListCreateResponseFieldValueType = "SINGLE_SELECT"` - `const ListCreateResponseFieldValueTypeSocialHandle ListCreateResponseFieldValueType = "SOCIAL_HANDLE"` - `const ListCreateResponseFieldValueTypeTelephone ListCreateResponseFieldValueType = "TELEPHONE"` - `const ListCreateResponseFieldValueTypeText ListCreateResponseFieldValueType = "TEXT"` - `const ListCreateResponseFieldValueTypeURL ListCreateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the list in the Lightfield web app, or null. ### List List Accounts Response - `type ListListAccountsResponse struct{…}` - `Data []ListListAccountsResponseData` 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, ListListAccountsResponseDataField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value ListListAccountsResponseDataFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListListAccountsResponseDataFieldValueArray []string` - `type ListListAccountsResponseDataFieldValueAddress 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 ListListAccountsResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListListAccountsResponseDataFieldValueTypeAddress ListListAccountsResponseDataFieldValueType = "ADDRESS"` - `const ListListAccountsResponseDataFieldValueTypeCheckbox ListListAccountsResponseDataFieldValueType = "CHECKBOX"` - `const ListListAccountsResponseDataFieldValueTypeCurrency ListListAccountsResponseDataFieldValueType = "CURRENCY"` - `const ListListAccountsResponseDataFieldValueTypeDatetime ListListAccountsResponseDataFieldValueType = "DATETIME"` - `const ListListAccountsResponseDataFieldValueTypeEmail ListListAccountsResponseDataFieldValueType = "EMAIL"` - `const ListListAccountsResponseDataFieldValueTypeFullName ListListAccountsResponseDataFieldValueType = "FULL_NAME"` - `const ListListAccountsResponseDataFieldValueTypeMarkdown ListListAccountsResponseDataFieldValueType = "MARKDOWN"` - `const ListListAccountsResponseDataFieldValueTypeMultiSelect ListListAccountsResponseDataFieldValueType = "MULTI_SELECT"` - `const ListListAccountsResponseDataFieldValueTypeNumber ListListAccountsResponseDataFieldValueType = "NUMBER"` - `const ListListAccountsResponseDataFieldValueTypeSingleSelect ListListAccountsResponseDataFieldValueType = "SINGLE_SELECT"` - `const ListListAccountsResponseDataFieldValueTypeSocialHandle ListListAccountsResponseDataFieldValueType = "SOCIAL_HANDLE"` - `const ListListAccountsResponseDataFieldValueTypeTelephone ListListAccountsResponseDataFieldValueType = "TELEPHONE"` - `const ListListAccountsResponseDataFieldValueTypeText ListListAccountsResponseDataFieldValueType = "TEXT"` - `const ListListAccountsResponseDataFieldValueTypeURL ListListAccountsResponseDataFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, ListListAccountsResponseDataRelationship]` 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. ### List List Contacts Response - `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. ### List List Opportunities Response - `type ListListOpportunitiesResponse struct{…}` - `Data []ListListOpportunitiesResponseData` 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, ListListOpportunitiesResponseDataField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value ListListOpportunitiesResponseDataFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListListOpportunitiesResponseDataFieldValueArray []string` - `type ListListOpportunitiesResponseDataFieldValueAddress 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 ListListOpportunitiesResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListListOpportunitiesResponseDataFieldValueTypeAddress ListListOpportunitiesResponseDataFieldValueType = "ADDRESS"` - `const ListListOpportunitiesResponseDataFieldValueTypeCheckbox ListListOpportunitiesResponseDataFieldValueType = "CHECKBOX"` - `const ListListOpportunitiesResponseDataFieldValueTypeCurrency ListListOpportunitiesResponseDataFieldValueType = "CURRENCY"` - `const ListListOpportunitiesResponseDataFieldValueTypeDatetime ListListOpportunitiesResponseDataFieldValueType = "DATETIME"` - `const ListListOpportunitiesResponseDataFieldValueTypeEmail ListListOpportunitiesResponseDataFieldValueType = "EMAIL"` - `const ListListOpportunitiesResponseDataFieldValueTypeFullName ListListOpportunitiesResponseDataFieldValueType = "FULL_NAME"` - `const ListListOpportunitiesResponseDataFieldValueTypeMarkdown ListListOpportunitiesResponseDataFieldValueType = "MARKDOWN"` - `const ListListOpportunitiesResponseDataFieldValueTypeMultiSelect ListListOpportunitiesResponseDataFieldValueType = "MULTI_SELECT"` - `const ListListOpportunitiesResponseDataFieldValueTypeNumber ListListOpportunitiesResponseDataFieldValueType = "NUMBER"` - `const ListListOpportunitiesResponseDataFieldValueTypeSingleSelect ListListOpportunitiesResponseDataFieldValueType = "SINGLE_SELECT"` - `const ListListOpportunitiesResponseDataFieldValueTypeSocialHandle ListListOpportunitiesResponseDataFieldValueType = "SOCIAL_HANDLE"` - `const ListListOpportunitiesResponseDataFieldValueTypeTelephone ListListOpportunitiesResponseDataFieldValueType = "TELEPHONE"` - `const ListListOpportunitiesResponseDataFieldValueTypeText ListListOpportunitiesResponseDataFieldValueType = "TEXT"` - `const ListListOpportunitiesResponseDataFieldValueTypeURL ListListOpportunitiesResponseDataFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, ListListOpportunitiesResponseDataRelationship]` 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. ### List List Response - `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. - `string` - `float64` - `bool` - `type ListListResponseDataFieldValueArray []string` - `type ListListResponseDataFieldValueAddress 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 ListListResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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. ### List Retrieve Response - `type ListRetrieveResponse struct{…}` - `ID string` Unique identifier for the list. - `CreatedAt string` ISO 8601 timestamp of when the list was created. - `Fields map[string, ListRetrieveResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `Value ListRetrieveResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListRetrieveResponseFieldValueArray []string` - `type ListRetrieveResponseFieldValueAddress 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 ListRetrieveResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListRetrieveResponseFieldValueTypeAddress ListRetrieveResponseFieldValueType = "ADDRESS"` - `const ListRetrieveResponseFieldValueTypeCheckbox ListRetrieveResponseFieldValueType = "CHECKBOX"` - `const ListRetrieveResponseFieldValueTypeCurrency ListRetrieveResponseFieldValueType = "CURRENCY"` - `const ListRetrieveResponseFieldValueTypeDatetime ListRetrieveResponseFieldValueType = "DATETIME"` - `const ListRetrieveResponseFieldValueTypeEmail ListRetrieveResponseFieldValueType = "EMAIL"` - `const ListRetrieveResponseFieldValueTypeFullName ListRetrieveResponseFieldValueType = "FULL_NAME"` - `const ListRetrieveResponseFieldValueTypeMarkdown ListRetrieveResponseFieldValueType = "MARKDOWN"` - `const ListRetrieveResponseFieldValueTypeMultiSelect ListRetrieveResponseFieldValueType = "MULTI_SELECT"` - `const ListRetrieveResponseFieldValueTypeNumber ListRetrieveResponseFieldValueType = "NUMBER"` - `const ListRetrieveResponseFieldValueTypeSingleSelect ListRetrieveResponseFieldValueType = "SINGLE_SELECT"` - `const ListRetrieveResponseFieldValueTypeSocialHandle ListRetrieveResponseFieldValueType = "SOCIAL_HANDLE"` - `const ListRetrieveResponseFieldValueTypeTelephone ListRetrieveResponseFieldValueType = "TELEPHONE"` - `const ListRetrieveResponseFieldValueTypeText ListRetrieveResponseFieldValueType = "TEXT"` - `const ListRetrieveResponseFieldValueTypeURL ListRetrieveResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the list in the Lightfield web app, or null. ### List Update Response - `type ListUpdateResponse struct{…}` - `ID string` Unique identifier for the list. - `CreatedAt string` ISO 8601 timestamp of when the list was created. - `Fields map[string, ListUpdateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `Value ListUpdateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type ListUpdateResponseFieldValueArray []string` - `type ListUpdateResponseFieldValueAddress 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 ListUpdateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const ListUpdateResponseFieldValueTypeAddress ListUpdateResponseFieldValueType = "ADDRESS"` - `const ListUpdateResponseFieldValueTypeCheckbox ListUpdateResponseFieldValueType = "CHECKBOX"` - `const ListUpdateResponseFieldValueTypeCurrency ListUpdateResponseFieldValueType = "CURRENCY"` - `const ListUpdateResponseFieldValueTypeDatetime ListUpdateResponseFieldValueType = "DATETIME"` - `const ListUpdateResponseFieldValueTypeEmail ListUpdateResponseFieldValueType = "EMAIL"` - `const ListUpdateResponseFieldValueTypeFullName ListUpdateResponseFieldValueType = "FULL_NAME"` - `const ListUpdateResponseFieldValueTypeMarkdown ListUpdateResponseFieldValueType = "MARKDOWN"` - `const ListUpdateResponseFieldValueTypeMultiSelect ListUpdateResponseFieldValueType = "MULTI_SELECT"` - `const ListUpdateResponseFieldValueTypeNumber ListUpdateResponseFieldValueType = "NUMBER"` - `const ListUpdateResponseFieldValueTypeSingleSelect ListUpdateResponseFieldValueType = "SINGLE_SELECT"` - `const ListUpdateResponseFieldValueTypeSocialHandle ListUpdateResponseFieldValueType = "SOCIAL_HANDLE"` - `const ListUpdateResponseFieldValueTypeTelephone ListUpdateResponseFieldValueType = "TELEPHONE"` - `const ListUpdateResponseFieldValueTypeText ListUpdateResponseFieldValueType = "TEXT"` - `const ListUpdateResponseFieldValueTypeURL ListUpdateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the list in the Lightfield web app, or null.