# Account ## Get account field definitions `client.Account.Definitions(ctx) (*AccountDefinitionsResponse, error)` **get** `/v1/accounts/definitions` Returns the schema for all field and relationship definitions available on accounts, including both system-defined and custom fields. Useful for understanding the shape of account data before creating or updating records. See [Fields and relationships](/using-the-api/fields-and-relationships/) for more details. **[Required scope](/using-the-api/scopes/):** `accounts:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Returns - `type AccountDefinitionsResponse struct{…}` - `FieldDefinitions map[string, AccountDefinitionsResponseFieldDefinition]` Map of field keys to their definitions, including both system and custom fields. - `Description string` Description of the field, or null. - `Label string` Human-readable display name of the field. - `TypeConfiguration AccountDefinitionsResponseFieldDefinitionTypeConfiguration` Type-specific configuration (e.g. select options, currency code). - `Currency string` ISO 4217 3-letter currency code. - `HandleService string` Social platform associated with this handle field. - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"` - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"` - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"` - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"` - `MultipleValues bool` Whether this field accepts multiple values. - `Options []AccountDefinitionsResponseFieldDefinitionTypeConfigurationOption` Available options for select fields. - `ID string` Unique identifier of the select option. - `Label string` Human-readable display name of the option. - `Description string` Description of the option, or null. - `Unique bool` Whether values for this field must be unique. - `ValueType string` Data type of the field. - `const AccountDefinitionsResponseFieldDefinitionValueTypeAddress AccountDefinitionsResponseFieldDefinitionValueType = "ADDRESS"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeCheckbox AccountDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeCurrency AccountDefinitionsResponseFieldDefinitionValueType = "CURRENCY"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeDatetime AccountDefinitionsResponseFieldDefinitionValueType = "DATETIME"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeEmail AccountDefinitionsResponseFieldDefinitionValueType = "EMAIL"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeFullName AccountDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeMarkdown AccountDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeMultiSelect AccountDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeNumber AccountDefinitionsResponseFieldDefinitionValueType = "NUMBER"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeSingleSelect AccountDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeSocialHandle AccountDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeTelephone AccountDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeText AccountDefinitionsResponseFieldDefinitionValueType = "TEXT"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeURL AccountDefinitionsResponseFieldDefinitionValueType = "URL"` - `ID string` Unique identifier of the field definition. - `ReadOnly bool` `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields. - `ObjectType string` The object type these definitions belong to (e.g. `account`). - `RelationshipDefinitions map[string, AccountDefinitionsResponseRelationshipDefinition]` Map of relationship keys to their definitions. - `Cardinality string` Whether this is a `has_one` or `has_many` relationship. - `const AccountDefinitionsResponseRelationshipDefinitionCardinalityHasOne AccountDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"` - `const AccountDefinitionsResponseRelationshipDefinitionCardinalityHasMany AccountDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"` - `Description string` Description of the relationship, or null. - `Label string` Human-readable display name of the relationship. - `ObjectType string` The type of the related object (e.g. `account`, `contact`). - `ID string` Unique identifier of the relationship definition. ### 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"), ) accountDefinitionsResponse, err := client.Account.Definitions(context.TODO()) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", accountDefinitionsResponse.FieldDefinitions) } ``` #### Response ```json { "fieldDefinitions": { "foo": { "description": "description", "label": "label", "typeConfiguration": { "currency": "currency", "handleService": "TWITTER", "multipleValues": true, "options": [ { "id": "id", "label": "label", "description": "description" } ], "unique": true }, "valueType": "ADDRESS", "id": "id", "readOnly": true } }, "objectType": "objectType", "relationshipDefinitions": { "foo": { "cardinality": "HAS_ONE", "description": "description", "label": "label", "objectType": "objectType", "id": "id" } } } ``` ## Create an account `client.Account.New(ctx, body) (*AccountCreateResponse, error)` **post** `/v1/accounts` Creates a new account record. The `$name` field is required. If a `$website` is provided, Lightfield automatically enriches the account in the background. The `$howTheyMakeMoney` and `$accountStatus` fields are read-only and cannot be set via the API. The `$opportunity`, `$task`, and `$note` relationships are also read-only — manage them via the `$account` relationship on the opportunity or task, or the `$account`/`$opportunity` note relationships instead. Supports idempotency via the `Idempotency-Key` header. To avoid duplicates, we recommend a find-or-create pattern — use [list filtering](/using-the-api/list-endpoints/#filtering) to check if a record exists before creating. **[Required scope](/using-the-api/scopes/):** `accounts:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `body AccountNewParams` - `Fields param.Field[map[string, AccountNewParamsFieldUnion]]` Field values for the new account. System fields use a `$` prefix (e.g. `$name`, `$website`); custom attributes use their bare slug (e.g. `tier`, `renewalDate`). Required: `$name` (string). Fields of type `SINGLE_SELECT` or `MULTI_SELECT` accept either an option ID or label from the field's `typeConfiguration.options` — call the [definitions endpoint](/api/resources/account/methods/definitions) to discover available fields and options. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `map[string, AccountNewParamsFieldUnion]` - `string` - `float64` - `bool` - `type AccountNewParamsFieldArray []string` - `type AccountNewParamsFieldAddress 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 AccountNewParamsFieldFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `Relationships param.Field[map[string, AccountNewParamsRelationshipUnion]]` Relationships to set on the new account. System relationships use a `$` prefix (e.g. `$owner`, `$contact`); custom relationships use their bare slug. Each value is a single entity ID or an array of IDs. Call the [definitions endpoint](/api/resources/account/methods/definitions) to list available relationship keys. - `map[string, AccountNewParamsRelationshipUnion]` - `string` - `type AccountNewParamsRelationshipArray []string` ### Returns - `type AccountCreateResponse struct{…}` - `ID string` Unique identifier for the entity. - `CreatedAt string` ISO 8601 timestamp of when the entity was created. - `Fields map[string, AccountCreateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountCreateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountCreateResponseFieldValueArray []string` - `type AccountCreateResponseFieldValueAddress 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 AccountCreateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountCreateResponseFieldValueTypeAddress AccountCreateResponseFieldValueType = "ADDRESS"` - `const AccountCreateResponseFieldValueTypeCheckbox AccountCreateResponseFieldValueType = "CHECKBOX"` - `const AccountCreateResponseFieldValueTypeCurrency AccountCreateResponseFieldValueType = "CURRENCY"` - `const AccountCreateResponseFieldValueTypeDatetime AccountCreateResponseFieldValueType = "DATETIME"` - `const AccountCreateResponseFieldValueTypeEmail AccountCreateResponseFieldValueType = "EMAIL"` - `const AccountCreateResponseFieldValueTypeFullName AccountCreateResponseFieldValueType = "FULL_NAME"` - `const AccountCreateResponseFieldValueTypeMarkdown AccountCreateResponseFieldValueType = "MARKDOWN"` - `const AccountCreateResponseFieldValueTypeMultiSelect AccountCreateResponseFieldValueType = "MULTI_SELECT"` - `const AccountCreateResponseFieldValueTypeNumber AccountCreateResponseFieldValueType = "NUMBER"` - `const AccountCreateResponseFieldValueTypeSingleSelect AccountCreateResponseFieldValueType = "SINGLE_SELECT"` - `const AccountCreateResponseFieldValueTypeSocialHandle AccountCreateResponseFieldValueType = "SOCIAL_HANDLE"` - `const AccountCreateResponseFieldValueTypeTelephone AccountCreateResponseFieldValueType = "TELEPHONE"` - `const AccountCreateResponseFieldValueTypeText AccountCreateResponseFieldValueType = "TEXT"` - `const AccountCreateResponseFieldValueTypeURL AccountCreateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountCreateResponseRelationship]` 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. ### 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"), ) accountCreateResponse, err := client.Account.New(context.TODO(), githubcomlightfldlightfieldgo.AccountNewParams{ Fields: map[string]githubcomlightfldlightfieldgo.AccountNewParamsFieldUnion{ "foo": githubcomlightfldlightfieldgo.AccountNewParamsFieldUnion{ OfString: githubcomlightfldlightfieldgo.String("string"), }, }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", accountCreateResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Update an account `client.Account.Update(ctx, id, body) (*AccountUpdateResponse, error)` **post** `/v1/accounts/{id}` Updates an existing account by ID. Only included fields and relationships are modified. The `$howTheyMakeMoney` and `$accountStatus` fields are read-only and cannot be updated. The `$opportunity`, `$task`, and `$note` relationships are also read-only — manage them via the `$account` relationship on the opportunity or task, or the `$account`/`$opportunity` note relationships instead. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `accounts:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id string` Unique identifier of the account to update. - `body AccountUpdateParams` - `Fields param.Field[map[string, AccountUpdateParamsFieldUnion]]` Field values to update — only provided fields are modified; omitted fields are left unchanged. System fields use a `$` prefix (e.g. `$name`); custom attributes use their bare slug. `SINGLE_SELECT` and `MULTI_SELECT` fields accept an option ID or label — call the [definitions endpoint](/api/resources/account/methods/definitions) for available options. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `map[string, AccountUpdateParamsFieldUnion]` - `string` - `float64` - `bool` - `type AccountUpdateParamsFieldArray []string` - `type AccountUpdateParamsFieldAddress 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 AccountUpdateParamsFieldFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `Relationships param.Field[map[string, AccountUpdateParamsRelationship]]` Relationship operations to apply. System relationships use a `$` prefix (e.g. `$owner`, `$contact`). Each value is an operation object with `add`, `remove`, or `replace`. - `map[string, AccountUpdateParamsRelationship]` - `Add AccountUpdateParamsRelationshipAddUnion` Entity ID(s) to add to the relationship. - `string` - `type AccountUpdateParamsRelationshipAddArray []string` - `Remove AccountUpdateParamsRelationshipRemoveUnion` Entity ID(s) to remove from the relationship. - `string` - `type AccountUpdateParamsRelationshipRemoveArray []string` - `Replace AccountUpdateParamsRelationshipReplaceUnion` Entity ID(s) to set as the entire relationship, replacing all existing associations. - `string` - `type AccountUpdateParamsRelationshipReplaceArray []string` ### Returns - `type AccountUpdateResponse struct{…}` - `ID string` Unique identifier for the entity. - `CreatedAt string` ISO 8601 timestamp of when the entity was created. - `Fields map[string, AccountUpdateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountUpdateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountUpdateResponseFieldValueArray []string` - `type AccountUpdateResponseFieldValueAddress 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 AccountUpdateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountUpdateResponseFieldValueTypeAddress AccountUpdateResponseFieldValueType = "ADDRESS"` - `const AccountUpdateResponseFieldValueTypeCheckbox AccountUpdateResponseFieldValueType = "CHECKBOX"` - `const AccountUpdateResponseFieldValueTypeCurrency AccountUpdateResponseFieldValueType = "CURRENCY"` - `const AccountUpdateResponseFieldValueTypeDatetime AccountUpdateResponseFieldValueType = "DATETIME"` - `const AccountUpdateResponseFieldValueTypeEmail AccountUpdateResponseFieldValueType = "EMAIL"` - `const AccountUpdateResponseFieldValueTypeFullName AccountUpdateResponseFieldValueType = "FULL_NAME"` - `const AccountUpdateResponseFieldValueTypeMarkdown AccountUpdateResponseFieldValueType = "MARKDOWN"` - `const AccountUpdateResponseFieldValueTypeMultiSelect AccountUpdateResponseFieldValueType = "MULTI_SELECT"` - `const AccountUpdateResponseFieldValueTypeNumber AccountUpdateResponseFieldValueType = "NUMBER"` - `const AccountUpdateResponseFieldValueTypeSingleSelect AccountUpdateResponseFieldValueType = "SINGLE_SELECT"` - `const AccountUpdateResponseFieldValueTypeSocialHandle AccountUpdateResponseFieldValueType = "SOCIAL_HANDLE"` - `const AccountUpdateResponseFieldValueTypeTelephone AccountUpdateResponseFieldValueType = "TELEPHONE"` - `const AccountUpdateResponseFieldValueTypeText AccountUpdateResponseFieldValueType = "TEXT"` - `const AccountUpdateResponseFieldValueTypeURL AccountUpdateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountUpdateResponseRelationship]` 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. ### 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"), ) accountUpdateResponse, err := client.Account.Update( context.TODO(), "id", githubcomlightfldlightfieldgo.AccountUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", accountUpdateResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Retrieve an account `client.Account.Get(ctx, id) (*AccountRetrieveResponse, error)` **get** `/v1/accounts/{id}` Retrieves a single account by its ID. **[Required scope](/using-the-api/scopes/):** `accounts:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id string` Unique identifier of the account to retrieve. ### Returns - `type AccountRetrieveResponse struct{…}` - `ID string` Unique identifier for the entity. - `CreatedAt string` ISO 8601 timestamp of when the entity was created. - `Fields map[string, AccountRetrieveResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountRetrieveResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountRetrieveResponseFieldValueArray []string` - `type AccountRetrieveResponseFieldValueAddress 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 AccountRetrieveResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountRetrieveResponseFieldValueTypeAddress AccountRetrieveResponseFieldValueType = "ADDRESS"` - `const AccountRetrieveResponseFieldValueTypeCheckbox AccountRetrieveResponseFieldValueType = "CHECKBOX"` - `const AccountRetrieveResponseFieldValueTypeCurrency AccountRetrieveResponseFieldValueType = "CURRENCY"` - `const AccountRetrieveResponseFieldValueTypeDatetime AccountRetrieveResponseFieldValueType = "DATETIME"` - `const AccountRetrieveResponseFieldValueTypeEmail AccountRetrieveResponseFieldValueType = "EMAIL"` - `const AccountRetrieveResponseFieldValueTypeFullName AccountRetrieveResponseFieldValueType = "FULL_NAME"` - `const AccountRetrieveResponseFieldValueTypeMarkdown AccountRetrieveResponseFieldValueType = "MARKDOWN"` - `const AccountRetrieveResponseFieldValueTypeMultiSelect AccountRetrieveResponseFieldValueType = "MULTI_SELECT"` - `const AccountRetrieveResponseFieldValueTypeNumber AccountRetrieveResponseFieldValueType = "NUMBER"` - `const AccountRetrieveResponseFieldValueTypeSingleSelect AccountRetrieveResponseFieldValueType = "SINGLE_SELECT"` - `const AccountRetrieveResponseFieldValueTypeSocialHandle AccountRetrieveResponseFieldValueType = "SOCIAL_HANDLE"` - `const AccountRetrieveResponseFieldValueTypeTelephone AccountRetrieveResponseFieldValueType = "TELEPHONE"` - `const AccountRetrieveResponseFieldValueTypeText AccountRetrieveResponseFieldValueType = "TEXT"` - `const AccountRetrieveResponseFieldValueTypeURL AccountRetrieveResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountRetrieveResponseRelationship]` 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. ### 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"), ) accountRetrieveResponse, err := client.Account.Get(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", accountRetrieveResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## List accounts `client.Account.List(ctx, query) (*AccountListResponse, error)` **get** `/v1/accounts` Returns a paginated list of accounts. Use `offset` and `limit` to paginate through results, and `$field` query parameters to filter. See [List endpoints](/using-the-api/list-endpoints/) for more information about [pagination](/using-the-api/list-endpoints/#pagination) and [filtering](/using-the-api/list-endpoints/#filtering). **[Required scope](/using-the-api/scopes/):** `accounts:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `query AccountListParams` - `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 AccountListResponse struct{…}` - `Data []AccountListResponseData` 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, AccountListResponseDataField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountListResponseDataFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountListResponseDataFieldValueArray []string` - `type AccountListResponseDataFieldValueAddress 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 AccountListResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountListResponseDataFieldValueTypeAddress AccountListResponseDataFieldValueType = "ADDRESS"` - `const AccountListResponseDataFieldValueTypeCheckbox AccountListResponseDataFieldValueType = "CHECKBOX"` - `const AccountListResponseDataFieldValueTypeCurrency AccountListResponseDataFieldValueType = "CURRENCY"` - `const AccountListResponseDataFieldValueTypeDatetime AccountListResponseDataFieldValueType = "DATETIME"` - `const AccountListResponseDataFieldValueTypeEmail AccountListResponseDataFieldValueType = "EMAIL"` - `const AccountListResponseDataFieldValueTypeFullName AccountListResponseDataFieldValueType = "FULL_NAME"` - `const AccountListResponseDataFieldValueTypeMarkdown AccountListResponseDataFieldValueType = "MARKDOWN"` - `const AccountListResponseDataFieldValueTypeMultiSelect AccountListResponseDataFieldValueType = "MULTI_SELECT"` - `const AccountListResponseDataFieldValueTypeNumber AccountListResponseDataFieldValueType = "NUMBER"` - `const AccountListResponseDataFieldValueTypeSingleSelect AccountListResponseDataFieldValueType = "SINGLE_SELECT"` - `const AccountListResponseDataFieldValueTypeSocialHandle AccountListResponseDataFieldValueType = "SOCIAL_HANDLE"` - `const AccountListResponseDataFieldValueTypeTelephone AccountListResponseDataFieldValueType = "TELEPHONE"` - `const AccountListResponseDataFieldValueTypeText AccountListResponseDataFieldValueType = "TEXT"` - `const AccountListResponseDataFieldValueTypeURL AccountListResponseDataFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountListResponseDataRelationship]` 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"), ) accountListResponse, err := client.Account.List(context.TODO(), githubcomlightfldlightfieldgo.AccountListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", accountListResponse.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 ### Account Create Response - `type AccountCreateResponse struct{…}` - `ID string` Unique identifier for the entity. - `CreatedAt string` ISO 8601 timestamp of when the entity was created. - `Fields map[string, AccountCreateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountCreateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountCreateResponseFieldValueArray []string` - `type AccountCreateResponseFieldValueAddress 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 AccountCreateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountCreateResponseFieldValueTypeAddress AccountCreateResponseFieldValueType = "ADDRESS"` - `const AccountCreateResponseFieldValueTypeCheckbox AccountCreateResponseFieldValueType = "CHECKBOX"` - `const AccountCreateResponseFieldValueTypeCurrency AccountCreateResponseFieldValueType = "CURRENCY"` - `const AccountCreateResponseFieldValueTypeDatetime AccountCreateResponseFieldValueType = "DATETIME"` - `const AccountCreateResponseFieldValueTypeEmail AccountCreateResponseFieldValueType = "EMAIL"` - `const AccountCreateResponseFieldValueTypeFullName AccountCreateResponseFieldValueType = "FULL_NAME"` - `const AccountCreateResponseFieldValueTypeMarkdown AccountCreateResponseFieldValueType = "MARKDOWN"` - `const AccountCreateResponseFieldValueTypeMultiSelect AccountCreateResponseFieldValueType = "MULTI_SELECT"` - `const AccountCreateResponseFieldValueTypeNumber AccountCreateResponseFieldValueType = "NUMBER"` - `const AccountCreateResponseFieldValueTypeSingleSelect AccountCreateResponseFieldValueType = "SINGLE_SELECT"` - `const AccountCreateResponseFieldValueTypeSocialHandle AccountCreateResponseFieldValueType = "SOCIAL_HANDLE"` - `const AccountCreateResponseFieldValueTypeTelephone AccountCreateResponseFieldValueType = "TELEPHONE"` - `const AccountCreateResponseFieldValueTypeText AccountCreateResponseFieldValueType = "TEXT"` - `const AccountCreateResponseFieldValueTypeURL AccountCreateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountCreateResponseRelationship]` 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. ### Account Definitions Response - `type AccountDefinitionsResponse struct{…}` - `FieldDefinitions map[string, AccountDefinitionsResponseFieldDefinition]` Map of field keys to their definitions, including both system and custom fields. - `Description string` Description of the field, or null. - `Label string` Human-readable display name of the field. - `TypeConfiguration AccountDefinitionsResponseFieldDefinitionTypeConfiguration` Type-specific configuration (e.g. select options, currency code). - `Currency string` ISO 4217 3-letter currency code. - `HandleService string` Social platform associated with this handle field. - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"` - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"` - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"` - `const AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram AccountDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"` - `MultipleValues bool` Whether this field accepts multiple values. - `Options []AccountDefinitionsResponseFieldDefinitionTypeConfigurationOption` Available options for select fields. - `ID string` Unique identifier of the select option. - `Label string` Human-readable display name of the option. - `Description string` Description of the option, or null. - `Unique bool` Whether values for this field must be unique. - `ValueType string` Data type of the field. - `const AccountDefinitionsResponseFieldDefinitionValueTypeAddress AccountDefinitionsResponseFieldDefinitionValueType = "ADDRESS"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeCheckbox AccountDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeCurrency AccountDefinitionsResponseFieldDefinitionValueType = "CURRENCY"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeDatetime AccountDefinitionsResponseFieldDefinitionValueType = "DATETIME"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeEmail AccountDefinitionsResponseFieldDefinitionValueType = "EMAIL"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeFullName AccountDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeMarkdown AccountDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeMultiSelect AccountDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeNumber AccountDefinitionsResponseFieldDefinitionValueType = "NUMBER"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeSingleSelect AccountDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeSocialHandle AccountDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeTelephone AccountDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeText AccountDefinitionsResponseFieldDefinitionValueType = "TEXT"` - `const AccountDefinitionsResponseFieldDefinitionValueTypeURL AccountDefinitionsResponseFieldDefinitionValueType = "URL"` - `ID string` Unique identifier of the field definition. - `ReadOnly bool` `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields. - `ObjectType string` The object type these definitions belong to (e.g. `account`). - `RelationshipDefinitions map[string, AccountDefinitionsResponseRelationshipDefinition]` Map of relationship keys to their definitions. - `Cardinality string` Whether this is a `has_one` or `has_many` relationship. - `const AccountDefinitionsResponseRelationshipDefinitionCardinalityHasOne AccountDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"` - `const AccountDefinitionsResponseRelationshipDefinitionCardinalityHasMany AccountDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"` - `Description string` Description of the relationship, or null. - `Label string` Human-readable display name of the relationship. - `ObjectType string` The type of the related object (e.g. `account`, `contact`). - `ID string` Unique identifier of the relationship definition. ### Account List Response - `type AccountListResponse struct{…}` - `Data []AccountListResponseData` 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, AccountListResponseDataField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountListResponseDataFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountListResponseDataFieldValueArray []string` - `type AccountListResponseDataFieldValueAddress 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 AccountListResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountListResponseDataFieldValueTypeAddress AccountListResponseDataFieldValueType = "ADDRESS"` - `const AccountListResponseDataFieldValueTypeCheckbox AccountListResponseDataFieldValueType = "CHECKBOX"` - `const AccountListResponseDataFieldValueTypeCurrency AccountListResponseDataFieldValueType = "CURRENCY"` - `const AccountListResponseDataFieldValueTypeDatetime AccountListResponseDataFieldValueType = "DATETIME"` - `const AccountListResponseDataFieldValueTypeEmail AccountListResponseDataFieldValueType = "EMAIL"` - `const AccountListResponseDataFieldValueTypeFullName AccountListResponseDataFieldValueType = "FULL_NAME"` - `const AccountListResponseDataFieldValueTypeMarkdown AccountListResponseDataFieldValueType = "MARKDOWN"` - `const AccountListResponseDataFieldValueTypeMultiSelect AccountListResponseDataFieldValueType = "MULTI_SELECT"` - `const AccountListResponseDataFieldValueTypeNumber AccountListResponseDataFieldValueType = "NUMBER"` - `const AccountListResponseDataFieldValueTypeSingleSelect AccountListResponseDataFieldValueType = "SINGLE_SELECT"` - `const AccountListResponseDataFieldValueTypeSocialHandle AccountListResponseDataFieldValueType = "SOCIAL_HANDLE"` - `const AccountListResponseDataFieldValueTypeTelephone AccountListResponseDataFieldValueType = "TELEPHONE"` - `const AccountListResponseDataFieldValueTypeText AccountListResponseDataFieldValueType = "TEXT"` - `const AccountListResponseDataFieldValueTypeURL AccountListResponseDataFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountListResponseDataRelationship]` 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. ### Account Retrieve Response - `type AccountRetrieveResponse struct{…}` - `ID string` Unique identifier for the entity. - `CreatedAt string` ISO 8601 timestamp of when the entity was created. - `Fields map[string, AccountRetrieveResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountRetrieveResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountRetrieveResponseFieldValueArray []string` - `type AccountRetrieveResponseFieldValueAddress 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 AccountRetrieveResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountRetrieveResponseFieldValueTypeAddress AccountRetrieveResponseFieldValueType = "ADDRESS"` - `const AccountRetrieveResponseFieldValueTypeCheckbox AccountRetrieveResponseFieldValueType = "CHECKBOX"` - `const AccountRetrieveResponseFieldValueTypeCurrency AccountRetrieveResponseFieldValueType = "CURRENCY"` - `const AccountRetrieveResponseFieldValueTypeDatetime AccountRetrieveResponseFieldValueType = "DATETIME"` - `const AccountRetrieveResponseFieldValueTypeEmail AccountRetrieveResponseFieldValueType = "EMAIL"` - `const AccountRetrieveResponseFieldValueTypeFullName AccountRetrieveResponseFieldValueType = "FULL_NAME"` - `const AccountRetrieveResponseFieldValueTypeMarkdown AccountRetrieveResponseFieldValueType = "MARKDOWN"` - `const AccountRetrieveResponseFieldValueTypeMultiSelect AccountRetrieveResponseFieldValueType = "MULTI_SELECT"` - `const AccountRetrieveResponseFieldValueTypeNumber AccountRetrieveResponseFieldValueType = "NUMBER"` - `const AccountRetrieveResponseFieldValueTypeSingleSelect AccountRetrieveResponseFieldValueType = "SINGLE_SELECT"` - `const AccountRetrieveResponseFieldValueTypeSocialHandle AccountRetrieveResponseFieldValueType = "SOCIAL_HANDLE"` - `const AccountRetrieveResponseFieldValueTypeTelephone AccountRetrieveResponseFieldValueType = "TELEPHONE"` - `const AccountRetrieveResponseFieldValueTypeText AccountRetrieveResponseFieldValueType = "TEXT"` - `const AccountRetrieveResponseFieldValueTypeURL AccountRetrieveResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountRetrieveResponseRelationship]` 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. ### Account Update Response - `type AccountUpdateResponse struct{…}` - `ID string` Unique identifier for the entity. - `CreatedAt string` ISO 8601 timestamp of when the entity was created. - `Fields map[string, AccountUpdateResponseField]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `Value AccountUpdateResponseFieldValueUnion` The field value, or null if unset. - `string` - `float64` - `bool` - `type AccountUpdateResponseFieldValueArray []string` - `type AccountUpdateResponseFieldValueAddress 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 AccountUpdateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `const AccountUpdateResponseFieldValueTypeAddress AccountUpdateResponseFieldValueType = "ADDRESS"` - `const AccountUpdateResponseFieldValueTypeCheckbox AccountUpdateResponseFieldValueType = "CHECKBOX"` - `const AccountUpdateResponseFieldValueTypeCurrency AccountUpdateResponseFieldValueType = "CURRENCY"` - `const AccountUpdateResponseFieldValueTypeDatetime AccountUpdateResponseFieldValueType = "DATETIME"` - `const AccountUpdateResponseFieldValueTypeEmail AccountUpdateResponseFieldValueType = "EMAIL"` - `const AccountUpdateResponseFieldValueTypeFullName AccountUpdateResponseFieldValueType = "FULL_NAME"` - `const AccountUpdateResponseFieldValueTypeMarkdown AccountUpdateResponseFieldValueType = "MARKDOWN"` - `const AccountUpdateResponseFieldValueTypeMultiSelect AccountUpdateResponseFieldValueType = "MULTI_SELECT"` - `const AccountUpdateResponseFieldValueTypeNumber AccountUpdateResponseFieldValueType = "NUMBER"` - `const AccountUpdateResponseFieldValueTypeSingleSelect AccountUpdateResponseFieldValueType = "SINGLE_SELECT"` - `const AccountUpdateResponseFieldValueTypeSocialHandle AccountUpdateResponseFieldValueType = "SOCIAL_HANDLE"` - `const AccountUpdateResponseFieldValueTypeTelephone AccountUpdateResponseFieldValueType = "TELEPHONE"` - `const AccountUpdateResponseFieldValueTypeText AccountUpdateResponseFieldValueType = "TEXT"` - `const AccountUpdateResponseFieldValueTypeURL AccountUpdateResponseFieldValueType = "URL"` - `HTTPLink string` URL to view the entity in the Lightfield web app, or null. - `Relationships map[string, AccountUpdateResponseRelationship]` 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.