User | Subrite

User

Endpoints for User

ReferenceUpdated October 12, 2026View as Markdown

GET/api/v1/users

Authentication: Bearer token (JWT)

Parameters

Query parameters5

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"
searchstringOptional
Search users by name or email (minimum 3 characters)minLength: 3maxLength: 100

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleUserResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of UserResponseRequired32 fields
items
- isCompanybooleanField path: items[].isCompany
- companyName

Example requestcurl

curl

curl https://api.subrite.no/api/v1/users \
  --header 'Authorization: Bearer <token>'

Try it

Create a new user#

POST/api/v1/users

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateUserDto

4 top-level fields

fullNamestringRequired
emailstring (email)Optional
Can be nullmaxLength: 255
phonestringOptional
maxLength:

GET/api/v1/users/exists-by-email

Authentication: Bearer token (JWT)

Parameters

Query parameters1

emailstring (email)Required
maxLength: 255

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

GET/api/v1/users/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleUserResponse

Same fields as Create a new user (201).

DELETE/api/v1/users/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

This response has no body.

Responses 400

PATCH/api/v1/users/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateUserDto

5 top-level fieldsSelect an object to expand

fullNamestringOptional
emailstring (email)Optional
Can be null

string

Schema ExampleUserResponsePaginated

200 · application/json

{
  "items": [
    {
      "permissions": [],
      "userRoles": [],
      "notes": [],
      "exportHistory": [],
      "userAccounts": [],
      "userSessions": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 21 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest, internalServerError (validation); field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

20

Schema ExampleCreateUserDto

application/json

{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "phone": "<phone>",
  "roleId": 1
}

Example · 6 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleUserResponse

32 top-level fieldsSelect an object to expand

isCompanyboolean
companyNamestring
organizationNostring
roleRole11 fields
role
- namestringRequired when parent is presentField path: role.name
- tenantIdnumberRequired when parent is presentField path: role.tenantId
- isActivebooleanRequired when parent is presentField path: role.isActive
- userRolesarray of UserRoleRequired when parent is presentField path: role.userRolesNested fields omitted: field limit.
- rolePermissionsarray of RolePermissionRequired when parent is presentField path: role.rolePermissionsNested fields omitted: field limit.
- tenantTenantRequired when parent is presentField path: role.tenantNested fields omitted: field limit.
permissionsarray of SectionPermission4 fields
permissions
- sectionIdstringRequired when parent is presentField path: permissions[].sectionId
  maxLength: 255
- sectionNamestringField path: permissions[].sectionName
  maxLength: 255
- readPermissionbooleanRequired when parent is presentField path: permissions[].readPermission
- updatePermissionbooleanRequired when parent is presentField path: permissions[].updatePermission
userSettingsUserSettings11 fields
userSettings
- notificationNotificationPreferencesDtoRequired when parent is presentField path: userSettings.notification
  Can be null
  Nested fields omitted: field limit.
- idnumberRequired when parent is presentField path: userSettings.id
- createdAtstring (date-time)Required when parent is presentField path: userSettings.createdAt
- updatedAtstring (date-time)Required when parent is presentField path: userSettings.updatedAt
- deletedAtstring (date-time)
nicknamestring
avatarstring
hasActiveSubscriptionboolean
userTypestringRequired
Allowed values: "system_admin", "tenant_admin", "member", "not_set"
tenantIdnumberRequired
emailstringRequired
Can be null
fullNamestringRequired
phonestringRequired
emailVerifiedstringRequired
Can be null
phoneVerifiedbooleanRequired
isOwnerbooleanRequired
isTestUserbooleanRequired
imagestringRequired
createdInCheckoutUuidstringRequired
userRolesarray of UserRole9 fields
userRoles
- userIdnumberRequired when parent is presentField path: userRoles[].userId
- roleIdnumberRequired when parent is presentField path: userRoles[].roleId
- userUserRequired when parent is presentField path: userRoles[].userNested fields omitted: field limit.
- roleRoleRequired when parent is presentField path: userRoles[].roleNested fields omitted: field limit.
- idnumberRequired when parent is presentField path: userRoles[].id
notesarray of NoteRequired12 fields
notes
- notestringRequired when parent is presentField path: notes[].note
- memberIdstringRequired when parent is presentField path: notes[].memberId
- adminUserIdnumberRequired when parent is presentField path: notes[].adminUserId
- memberMemberRequired when parent is presentField path: notes[].memberNested fields omitted: field limit.
- adminUserUserRequired when parent is presentField path: notes[].adminUserNested fields omitted: field limit.
exportHistoryarray of ExportHistoryRequiredNested fields omitted: field limit.
memberMemberNested fields omitted: field limit.
tenantTenantRequiredNested fields omitted: field limit.
userAccountsarray of UserAccountRequiredNested fields omitted: field limit.
userSessionsarray of UserSessionRequiredNested fields omitted: field limit.
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

79 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleUserResponse

201 · application/json

Responses 400

Status201 400 401 403 404 500application/json

badRequest, internalServerError (validation); field codes in errors[]

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 404

Status201 400 401 403 404 500application/json

roleNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "roleNotFound"
messagestring
errorsarray of FieldErrorRequired

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all users of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/users \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "phone": "<phone>",
  "roleId": 1
}'

UserExistResponse

Responses 400

Status200 400 401 403 500application/json

badRequest, internalServerError (validation); field codes in errors[]

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

UserResponse

200 · application/json

{
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "role": {
    "name": "string",
    "tenantId": 0,
    "isActive": true,
    "userRoles": [],
    "rolePermissions": [],
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "permissions": [
    {}
  ],
  "userSettings": {
    "notification": {},
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "receiveAdminEmails": true,
    "twoFactorAuth": true,
    "hasSignedDPA": true,
    "language": "en",
    "metaData": {},
    "user": {
      "userRoles": [],
      "notes": [],
      "exportHistory": [],
      "userAccounts": [],
      "userSessions": [],
      "metaData": {}
    }
  },
  "nickname": "string",
  "avatar": "string",
  "hasActiveSubscription": true,
  "userType": "system_admin",
  "tenantId": 0,
  "email": "string",
  "fullName": "<fullName>",
  "phone": "<phone>",
  "emailVerified": "string",
  "phoneVerified": true,
  "isOwner": true,
  "isTestUser": true,
  "image": "string",
  "createdInCheckoutUuid": "string",
  "userRoles": [
    {
      "metaData": {}
    }
  ],
  "notes": [
    {
      "metaData": {}
    }
  ],
  "exportHistory": [
    {
      "metaData": {}
    }
  ],
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "userAccounts": [
    {}
  ],
  "userSessions": [
    {}
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 216 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

userNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "userNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "userNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Get user by id (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

userNotFound

Schema ExampleErrorResponse

Same fields as Get user by id (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "userNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleUpdateUserDto

application/json

{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "phone": "<phone>",
  "roleId": 1,
  "userSettings": {
    "receiveAdminEmails": true,
    "twoFactorAuth": true,
    "hasSignedDPA": true,
    "language": "en"
  }
}

Example · 12 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleUserResponse

Same fields as Create a new user (201).

Schema ExampleUserResponse

200 · application/json

{
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "role": {
    "name": "string",
    "tenantId": 0,
    "isActive": true,
    "userRoles": [],
    "rolePermissions": [],
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "permissions": [
    {}
  ],
  "userSettings": {
    "notification": {},
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "receiveAdminEmails": true,
    "twoFactorAuth": true,
    "hasSignedDPA": true,
    "language": "en",
    "metaData": {},
    "user": {
      "userRoles": [],
      "notes": [],
      "exportHistory": [],
      "userAccounts": [],
      "userSessions": [],
      "metaData": {}
    }
  },
  "nickname": "string",
  "avatar": "string",
  "hasActiveSubscription": true,
  "userType": "system_admin",
  "tenantId": 0,
  "email": "string",
  "fullName": "<fullName>",
  "phone": "<phone>",
  "emailVerified": "string",
  "phoneVerified": true,
  "isOwner": true,
  "isTestUser": true,
  "image": "string",
  "createdInCheckoutUuid": "string",
  "userRoles": [
    {
      "metaData": {}
    }
  ],
  "notes": [
    {
      "metaData": {}
    }
  ],
  "exportHistory": [
    {
      "metaData": {}
    }
  ],
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "userAccounts": [
    {}
  ],
  "userSessions": [
    {}
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 216 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest (incl. phoneAlreadyVerified in errors[]), internalServerError (validation)

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all users of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 404

Status200 400 401 403 404 500application/json

userNotFound, roleNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "userNotFound", "roleNotFound"
messagestring
errorsarray of FieldError

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all users of the tenant (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/users/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "phone": "<phone>",
  "roleId": 1,
  "userSettings": {
    "receiveAdminEmails": true,
    "twoFactorAuth": true,
    "hasSignedDPA": true,
    "language": "en",
    "notification": {}
  }
}'

{
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "role": {
    "name": "string",
    "tenantId": 0,
    "isActive": true,
    "userRoles": [],
    "rolePermissions": [],
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "permissions": [
    {}
  ],
  "userSettings": {
    "notification": {},
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "receiveAdminEmails": true,
    "twoFactorAuth": true,
    "hasSignedDPA": true,
    "language": "en",
    "metaData": {},
    "user": {
      "userRoles": [],
      "notes": [],
      "exportHistory": [],
      "userAccounts": [],
      "userSessions": [],
      "metaData": {}
    }
  },
  "nickname": "string",
  "avatar": "string",
  "hasActiveSubscription": true,
  "userType": "system_admin",
  "tenantId": 0,
  "email": "string",
  "fullName": "<fullName>",
  "phone": "<phone>",
  "emailVerified": "string",
  "phoneVerified": true,
  "isOwner": true,
  "isTestUser": true,
  "image": "string",
  "createdInCheckoutUuid": "string",
  "userRoles": [
    {
      "metaData": {}
    }
  ],
  "notes": [
    {
      "metaData": {}
    }
  ],
  "exportHistory": [
    {
      "metaData": {}
    }
  ],
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "userAccounts": [
    {}
  ],
  "userSessions": [
    {}
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Get all users of the tenant#

Parameters

Responses

Responses 200

Create a new user#

Request body

Check if user exists by email#

Parameters

Responses

Responses 200

Get user by id#

Parameters

Responses

Responses 200

Delete user#

Parameters

Responses

Responses 200

Responses 400

Update user#

Parameters

Request body

Get all users of the tenant#

Parameters

Responses

Responses 200

Create a new user#

Request body

Check if user exists by email#

Parameters

Responses

Responses 200

Get user by id#

Parameters

Responses

Responses 200

Delete user#

Parameters

Responses

Responses 200

Responses 400

Update user#

Parameters

Request body

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Responses 400

Responses 401

Responses 403

Responses 500

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Responses 401

Responses 403

Responses 404

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500