v1
latestOpenAPI 3.0.12026-07-243686491.1 MBUsers
Retrieve users
Required scope: users:read </br>Organization authorization: supported
get/api/v1/users
Query parameters
pageinteger
page number to retrieve (starts with 0)
perPageinteger
number of items per page (between 1 and 100, default 10)
emailstring email
filter user by email
phonestring phone
filter user by phone
includeDeletedboolean
Set to 'true' to include deleted users, 'false' otherwise
fromUpdatedAtstring date-time
Filter to retrieve users where updatedAt >= fromUpdatedAt (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
Response
List of users that match the criteria
Example response
{
"data": [
{
"id": 10,
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"legalEmail": "legal@ut.com",
"phone": "+1234567890",
"profileImageUrl": "https://example.com/profile.jpg",
"address": {
"address1": "Strandboulevarden 122",
"address2": "København",
"address3": "5. sal",
"zip": "2100",
"city": "Copenhagen",
"province": "Lombardy",
"country": "Denmark",
"countryAreaId": 1
},
"language": "en",
"termsReadAt": "2023-06-21T15:03:14Z",
"taxIdentificationNumber": "X12345678A",
"vatNumber": " IT07643520567",
"recipientCode": "2021-10-001",
"createdAt": "2023-06-21T15:03:14Z",
"updatedAt": "2023-06-21T15:03:14Z",
"deletedAt": "2023-06-21T15:03:14Z",
"emailVerifiedAt": "2023-06-21T15:03:14Z",
"phoneVerifiedAt": "2023-06-21T15:03:14Z",
"marketingEmailsAcceptedAt": "2023-06-21T15:03:14Z",
"defaultTeamId": 10,
"nationalId": "123456-7890"
}
]
}