Skip to main content

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

GET 
/user-profile

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

Request​

Query Parameters

    q string

    The DataReadParams query as JSON or base64-encoded JSON - See POST route

    Example: {"filter": {"id": 1}}

Responses​

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

Schema

    data

    object[]

    required

  • Array [

    • 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 date-time

    The creation time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    created_by number

    The creator user id of this entity or mapping value - or zero if created by the system

    Example: 0
    modified_at date-time

    The last modification time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    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

    Example: 0
    deleted_at date-time

    The soft-deletion time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    deleted_by number

    The id of the user who deleted this entity or mapping value - or zero if deleted by the system

    Example: 0
    _etag stringrequired

    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 stringnullable

    An optional job title or organizational role description

    Example:
    display_name string

    The user's display name in this organization

    picture_data string

    User profile picture encoded as base64

    Example:
    display_language stringnullable

    The display language to use (e.g. en, de) - defaults to browser settings

    Example: en
    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

    Example: {}

  • ]

    • meta

    object

    required

    count integerrequired
    limit integer
    offset integerrequired
    totalCount integer
Loading...