Search entity profiles

Find entity profiles by name or identifier.

Use searchEntityProfiles to find profiles by entityName or identifier. As with individuals, profiles you can only see in a limited form are returned as an EntityLimitedProfile, and nextPageOfEntityProfiles fetches the next page.

Required scope: read-only

Request

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

Variables

{
  "input": {
    "entityName": "Citizen",
    "organizationId": "3f2b8c1e9a4d4e7f8b6c5d4e3f2a1b0c",
    "pageSize": 20
  }
}

Response

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

---