Skip to main content

Get entities from Users

GET 
/Users

Get entities from Users

Request​

Query Parameters

    $top integer

    Show only the first n items

    $skip integer

    Skip the first n items

    $search string

    Search items by search phrases

    $filter string

    Filter items by property values

    $count boolean

    Include count of items

    $orderby string[]

    Possible values: [reference, reference desc, userName, userName desc, avatar, avatar desc, twoFactorAuthenticationStatus, twoFactorAuthenticationStatus desc, tenantActivityStatus, tenantActivityStatus desc, isSeller, isSeller desc, currencyIso, currencyIso desc, languageIso, languageIso desc, culture, culture desc, lastActivity, lastActivity desc, crmId, crmId desc, contactId, contactId desc, id, id desc, createdDate, createdDate desc, updatedDate, updatedDate desc, organizationId, organizationId desc, creatorId, creatorId desc, customField1, customField1 desc, customField2, customField2 desc, customField3, customField3 desc, customField4, customField4 desc, customField5, customField5 desc]

    Order items by property values

    $select string[]

    Possible values: [reference, userName, avatar, twoFactorAuthenticationStatus, tenantActivityStatus, isSeller, currencyIso, languageIso, culture, lastActivity, crmId, contactId, id, createdDate, updatedDate, organizationId, creatorId, customField1, customField2, customField3, customField4, customField5, organization]

    Select properties to be returned

    $expand string[]

    Possible values: [*, organization]

    Expand related entities

Responses​

Retrieved entities

Schema

    value

    object[]

  • Array [

    • reference string
    userName string
    avatar string
    twoFactorAuthenticationStatus
    tenantActivityStatus
    isSeller boolean
    currencyIso string
    languageIso string
    culture string
    lastActivity date-time
    crmId uuid
    contactId uuid
    id uuid
    createdDate date-time
    updatedDate date-time
    organizationId uuid
    creatorId uuid
    customField1 string
    customField2 string
    customField3 string
    customField4 string
    customField5 string
    organization

  • ]

Loading...