Search profiles by custom field

Preview - not available in production and subject to change

Find individual or entity profiles with particular custom field values.

searchEntityProfiles and searchIndividualProfiles accept the same customFieldFilters as searchCases. Custom field filters can be used on their own, without a name or identifier.

Required scope: read-only

Request

query searchEntityProfiles($input: SearchEntityProfilesInput!) {
  searchEntityProfiles(input: $input) {
    ... on PageOfEntityProfilesMatchingSearch {
      profiles {
        __typename
        profileId
        legalName
        entityType
      }
      hasNextPage
      nextCursor
    }
    ... on ValidationErrors {
      errors {
        message
      }
    }
  }
}

Variables

{
  "input": {
    "organizationId": "3f2b8c1e9a4d4e7f8b6c5d4e3f2a1b0c",
    "customFieldFilters": [
      {
        "fieldKey": "01963b2e-5a2b-7d4e-9f6a-7b8c9d0e1f2a",
        "anyOptions": [
          "01963b2e-7c4d-7f6a-9b8c-9d0e1f2a3b4c",
          "01963b2e-8d5e-7a7b-8c9d-0e1f2a3b4c5d"
        ]
      }
    ],
    "pageSize": 20
  }
}

Response

{
  "data": {
    "searchEntityProfiles": {
      "profiles": [
        {
          "__typename": "EntityProfile",
          "profileId": "c7e5a3b1-9d2f-4c8e-a6b4-3f1e2d0c9b8a",
          "legalName": "Citizen Family Trust",
          "entityType": "TRUST"
        }
      ],
      "hasNextPage": false,
      "nextCursor": null
    }
  }
}

---