---
title: "Find 'UserProfile' entities using the specified (query) parameters"
method: GET
path: "/user-profile"
tags: ["UserProfile"]
---

# Find 'UserProfile' entities using the specified (query) parameters

`GET /user-profile`

## Request

- Base URL: `https://app.testiny.io/api/v1`
- URL: `https://app.testiny.io/api/v1/user-profile`
- Auth: API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/testiny/apis/testiny-api/docs/user-profile/get.ts> (a function with typed inputs; its response is checked against the schema)

Same as POST /find, but serializing the query in the 'q' parameter instead of the request body

## Query parameters

- `q` string

## Response `200`

Returns FindResult of type 'UserProfile' expanded with specified mapped values

- object
  - `data` UserProfile[], required
    - `id` integer: The unique entity id - must be a positive integer
    - `is_deleted` boolean: If the entity has been soft-deleted this value is true
    - `created_at` string, date-time: The creation time for this entity or mapping value
    - `created_by` number: The creator user id of this entity or mapping value - or zero if created by the system
    - `modified_at` string, date-time: The last modification time for this entity or mapping value
    - `modified_by` number: The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system
    - `deleted_at` string, date-time: The soft-deletion time for this entity or mapping value
    - `deleted_by` number: The id of the user who deleted this entity or mapping value - or zero if deleted by the system
    - `_etag` string, required: A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)
    - `user_id` integer: The global user id for this profile
    - `email` string: The user's primary email address for this organization
    - `job_title` string, nullable: An optional job title or organizational role description
    - `display_name` string: The user's display name in this organization
    - `picture_data` string: User profile picture as dataUri
    - `display_language` string, nullable: The display language to use (e.g. en, de) - defaults to browser settings
    - `is_active` boolean: True if the user is active in this organization - can be false if removed but not deleted
    - `is_invite_pending` boolean: True if the user has not yet confirmed an invite
    - `data` object: Other user-profile related settings, e.g. theme
  - `meta` object, required
    - `count` integer, required
    - `limit` integer
    - `offset` integer, required
    - `totalCount` integer

## Other responses

- `4XX`: The request failed because invalid request parameters or data were supplied or access was denied.
- `5XX`: The request failed because an error occurred during processing of the request.

---

[API](https://skmtc.dev/testiny/apis/testiny-api.md) - [All operations](https://skmtc.dev/testiny/apis/testiny-api/llms.txt) - [OpenAPI document](https://skmtc.dev/testiny/apis/testiny-api/revisions/8f7643b2429d?raw)
