Skip to main content
POST
/
profiles
/
search
JavaScript SDK
const response = await client.profiles.search({ search: { name: 'John' } });
{
  "items": [
    {
      "userIdentifier": "abcd",
      "lastUpdatedTime": 1730204346000,
      "givenName": "Jane",
      "surname": "Doe",
      "email": "jane.doe@example.com",
      "displayName": "Jane Doe",
      "jobTitle": "Software Engineer",
      "identityType": "USER"
    }
  ]
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

Query for user profile search.

limit
integer<int32>
default:25

<- Limits the maximum number of results to be returned by single request. The default is 25.

Required range: 1 <= x <= 1000

Response

200 - application/json

List of matched user profiles. If no user profile matches, you'll receive an empty set.

items
object[]
Last modified on April 23, 2026