Get entities from Users
GET/Users
Get entities from Users
Request
Query Parameters
Show only the first n items
Skip the first n items
Search items by search phrases
Filter items by property values
Include count of items
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
, permissions
, permissions 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
Possible values: [reference
, userName
, avatar
, twoFactorAuthenticationStatus
, tenantActivityStatus
, isSeller
, currencyIso
, languageIso
, culture
, lastActivity
, crmId
, contactId
, permissions
, id
, createdDate
, updatedDate
, organizationId
, creatorId
, customField1
, customField2
, customField3
, customField4
, customField5
, organization
]
Select properties to be returned
Possible values: [*
, organization
]
Expand related entities
Responses
- 200
- default
Retrieved entities
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
value
object[]
{
"value": [
{
"reference": "string",
"userName": "string",
"avatar": "string",
"twoFactorAuthenticationStatus": {},
"tenantActivityStatus": {},
"isSeller": true,
"currencyIso": "string",
"languageIso": "string",
"culture": "string",
"lastActivity": "2024-12-04T06:46:24.990Z",
"crmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"permissions": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2024-12-04T06:46:24.990Z",
"updatedDate": "2024-12-04T06:46:24.990Z",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"customField4": "string",
"customField5": "string",
"organization": {}
}
]
}
error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
required
details
object[]
The structure of this object is service-specific
{
"error": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string"
}
],
"innererror": {}
}
}