Search individual profiles

Find individual profiles by name, email or phone.

Use searchIndividualProfiles to find profiles by name, email or phone. A profile matching any supplied value is returned. Profiles that belong only to offices you can’t access, but that share their profiles in a limited form, are returned as an IndividualLimitedProfile with just their id and names. When hasNextPage is true, pass nextCursor to nextPageOfIndividualProfiles to fetch the next page.

Required scope: read-only

Request

query searchIndividualProfiles($input: SearchIndividualProfilesInput!) {
  searchIndividualProfiles(input: $input) {
    ... on PageOfIndividualProfilesMatchingSearch {
      profiles {
        __typename
        profileId
        preferredName {
          fullName
        }
        ... on IndividualProfile {
          dateOfBirth
          status
        }
      }
      hasNextPage
      nextCursor
    }
    ... on ValidationErrors {
      errors {
        message
      }
    }
  }
}

Variables

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

Response

{
  "data": {
    "searchIndividualProfiles": {
      "profiles": [
        {
          "__typename": "IndividualProfile",
          "profileId": "6d1f4b2a-3c8e-4a7d-9b5f-2e1c0d9a8b7c",
          "preferredName": {
            "fullName": "John Citizen"
          },
          "dateOfBirth": "1978-06-14",
          "status": "ACTIVE"
        },
        {
          "__typename": "IndividualLimitedProfile",
          "profileId": "e2b4d6f8-0a1c-4e3b-9d5f-7a8b9c0d1e2f",
          "preferredName": {
            "fullName": "Jane Citizen"
          }
        }
      ],
      "hasNextPage": false,
      "nextCursor": null
    }
  }
}

---