GET api/entity/customfield/GetEntityFieldContainers

Gets a list of custom fields associated with particular entities, e.g., persons, families, or organizations. EntityFieldContainers are requested using a "Keys" parameter, which is a comma-delimited the "objectID" and "objectTypeFlag" parameters, and can be filtered by the last time the field was updated (using the "since" parameter), or by known field identifiers (the "fieldIDs" parameter, a comma-delimited list of numbers).

Request Information

URI Parameters

Name	Description	Type	Additional information
Keys	Gets or sets the keys.	Collection of Key	None.
FieldIDs	Gets or sets the field i ds.	Collection of integer	None.
Since	Gets or sets the since.	date	None.

Body Parameters

None.

Response Information

Resource Description

A list of EntityFieldContainer objects.

WebMethodResultOfListOfEntityFieldContainer

Name	Type	Additional information
Result	Collection of EntityFieldContainer	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "EID": 1,
      "ObjectID": 2,
      "EntityType": 0,
      "EntityTypeID": 3,
      "Data": [
        {
          "FieldID": 1,
          "SeasonID": 1,
          "Updated": "2025-05-04T23:17:47.4264705-06:00",
          "UpdatedBy": "sample string 3",
          "Value": "sample string 4"
        },
        {
          "FieldID": 1,
          "SeasonID": 1,
          "Updated": "2025-05-04T23:17:47.4264705-06:00",
          "UpdatedBy": "sample string 3",
          "Value": "sample string 4"
        }
      ]
    },
    {
      "EID": 1,
      "ObjectID": 2,
      "EntityType": 0,
      "EntityTypeID": 3,
      "Data": [
        {
          "FieldID": 1,
          "SeasonID": 1,
          "Updated": "2025-05-04T23:17:47.4264705-06:00",
          "UpdatedBy": "sample string 3",
          "Value": "sample string 4"
        },
        {
          "FieldID": 1,
          "SeasonID": 1,
          "Updated": "2025-05-04T23:17:47.4264705-06:00",
          "UpdatedBy": "sample string 3",
          "Value": "sample string 4"
        }
      ]
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":[{"EID":1,"ObjectID":2,"EntityType":0,"EntityTypeID":3,"Data":[{"FieldID":1,"SeasonID":1,"Updated":"2025-05-04T23:17:47.4264705-06:00","UpdatedBy":"sample string 3","Value":"sample string 4"},{"FieldID":1,"SeasonID":1,"Updated":"2025-05-04T23:17:47.4264705-06:00","UpdatedBy":"sample string 3","Value":"sample string 4"}]},{"EID":1,"ObjectID":2,"EntityType":0,"EntityTypeID":3,"Data":[{"FieldID":1,"SeasonID":1,"Updated":"2025-05-04T23:17:47.4264705-06:00","UpdatedBy":"sample string 3","Value":"sample string 4"},{"FieldID":1,"SeasonID":1,"Updated":"2025-05-04T23:17:47.4264705-06:00","UpdatedBy":"sample string 3","Value":"sample string 4"}]}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfListOfEntityFieldContainer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <EntityFieldContainer>
      <EID>1</EID>
      <ObjectID>2</ObjectID>
      <EntityType>Undefined</EntityType>
      <EntityTypeID>3</EntityTypeID>
      <Data>
        <DataFieldAssignment>
          <FieldID>1</FieldID>
          <SeasonID>1</SeasonID>
          <Updated>2025-05-04T23:17:47.4264705-06:00</Updated>
          <UpdatedBy>sample string 3</UpdatedBy>
          <Value>sample string 4</Value>
        </DataFieldAssignment>
        <DataFieldAssignment>
          <FieldID>1</FieldID>
          <SeasonID>1</SeasonID>
          <Updated>2025-05-04T23:17:47.4264705-06:00</Updated>
          <UpdatedBy>sample string 3</UpdatedBy>
          <Value>sample string 4</Value>
        </DataFieldAssignment>
      </Data>
    </EntityFieldContainer>
    <EntityFieldContainer>
      <EID>1</EID>
      <ObjectID>2</ObjectID>
      <EntityType>Undefined</EntityType>
      <EntityTypeID>3</EntityTypeID>
      <Data>
        <DataFieldAssignment>
          <FieldID>1</FieldID>
          <SeasonID>1</SeasonID>
          <Updated>2025-05-04T23:17:47.4264705-06:00</Updated>
          <UpdatedBy>sample string 3</UpdatedBy>
          <Value>sample string 4</Value>
        </DataFieldAssignment>
        <DataFieldAssignment>
          <FieldID>1</FieldID>
          <SeasonID>1</SeasonID>
          <Updated>2025-05-04T23:17:47.4264705-06:00</Updated>
          <UpdatedBy>sample string 3</UpdatedBy>
          <Value>sample string 4</Value>
        </DataFieldAssignment>
      </Data>
    </EntityFieldContainer>
  </Result>
</WebMethodResultOfListOfEntityFieldContainer>