Admin Super Admin Only

Get all users with filters (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumber · min: 1OptionalDefault: 1

limitnumber · min: 1 · max: 100OptionalDefault: 20

searchstringOptional

Search in email, name, firstname, lastname, pseudo

rolestring · enumOptionalPossible values:

statusstringOptional

verifiedbooleanOptional

sortBystringOptionalDefault: created_at

sortOrderstring · enumOptionalPossible values:

minBrandsnumberOptional

Minimum number of brands

maxBrandsnumberOptional

Maximum number of brands

minProductsnumberOptional

Minimum number of products

maxProductsnumberOptional

Maximum number of products

Responses

200

Users retrieved successfully

No content

401

Unauthorized

403

Forbidden - AUTHENTIFY role required

get

/admin/users

HTTPcURLJavaScriptPython

GET /admin/users HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Search users for adding to brand (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptional

searchstringRequired

Responses

200

Users found successfully

No content

get

/admin/users/search

HTTPcURLJavaScriptPython

GET /admin/users/search?search=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Users found successfully

No content

Get detailed user information (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

User details retrieved successfully

No content

403

Forbidden - AUTHENTIFY role required

404

User not found

get

/admin/users/{userId}

HTTPcURLJavaScriptPython

GET /admin/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update user information (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Body

application/json

emailstringOptional

namestringOptional

firstnamestringOptional

lastnamestringOptional

rolestring · enumOptionalPossible values:

email_verifiedbooleanOptional

phone_numberstringOptional

phone_number_country_codestringOptional

phone_number_verifiedbooleanOptional

user_accept_notification_by_smsbooleanOptional

user_accept_notification_by_emailbooleanOptional

Responses

200

User updated successfully

No content

400

Invalid data

404

User not found

put

/admin/users/{userId}

HTTPcURLJavaScriptPython

PUT /admin/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "email": "text",
  "name": "text",
  "firstname": "text",
  "lastname": "text",
  "role": "BRAND",
  "email_verified": true,
  "phone_number": "text",
  "phone_number_country_code": "text",
  "phone_number_verified": true,
  "user_accept_notification_by_sms": true,
  "user_accept_notification_by_email": true
}

No content

Delete a user account (Super Admin only)

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

User deleted successfully

No content

400

Cannot delete user with active brands

404

User not found

delete

/admin/users/{userId}

HTTPcURLJavaScriptPython

DELETE /admin/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get user activity logs (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Query parameters

daysnumberRequired

Responses

200

User activity retrieved successfully

No content

404

User not found

get

/admin/users/{userId}/activity

HTTPcURLJavaScriptPython

GET /admin/users/{userId}/activity?days=1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get all brands associated with a user (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

User brands retrieved successfully

No content

get

/admin/users/{userId}/brands

HTTPcURLJavaScriptPython

GET /admin/users/{userId}/brands HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User brands retrieved successfully

No content

Get all products created by a user (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Query parameters

pagenumberRequired

limitnumberRequired

Responses

200

User products retrieved successfully

No content

get

/admin/users/{userId}/products

HTTPcURLJavaScriptPython

GET /admin/users/{userId}/products?page=1&limit=1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User products retrieved successfully

No content

Suspend a user account (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

User suspended successfully

No content

404

User not found

put

/admin/users/{userId}/suspend

HTTPcURLJavaScriptPython

PUT /admin/users/{userId}/suspend HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Activate a suspended user account (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

User activated successfully

No content

404

User not found

put

/admin/users/{userId}/activate

HTTPcURLJavaScriptPython

PUT /admin/users/{userId}/activate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Manually verify user email (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

Email verified successfully

No content

put

/admin/users/{userId}/verify-email

HTTPcURLJavaScriptPython

PUT /admin/users/{userId}/verify-email HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Email verified successfully

No content

Reset user MFA (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

MFA reset successfully

No content

put

/admin/users/{userId}/reset-mfa

HTTPcURLJavaScriptPython

PUT /admin/users/{userId}/reset-mfa HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

MFA reset successfully

No content

Get platform statistics (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Statistics retrieved successfully

No content

get

/admin/statistics

HTTPcURLJavaScriptPython

GET /admin/statistics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Statistics retrieved successfully

No content

Get audit logs (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

endDatestring · date-timeOptional

startDatestring · date-timeOptional

actionstringOptional

userIdstringOptional

limitnumberOptional

pagenumberOptional

Responses

200

Audit logs retrieved successfully

No content

get

/admin/audit-logs

HTTPcURLJavaScriptPython

GET /admin/audit-logs HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Audit logs retrieved successfully

No content

Get all brands with filters (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptional

pagenumberOptional

searchstringOptional

Responses

200

Brands retrieved successfully

No content

get

/admin/brands

HTTPcURLJavaScriptPython

GET /admin/brands HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Brands retrieved successfully

No content

Get brand details (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brandIdstringRequired

Responses

200

Brand details retrieved successfully

No content

404

Brand not found

get

/admin/brands/{brandId}

HTTPcURLJavaScriptPython

GET /admin/brands/{brandId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update brand (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brandIdstringRequired

Responses

200

Brand updated successfully

No content

404

Brand not found

put

/admin/brands/{brandId}

HTTPcURLJavaScriptPython

PUT /admin/brands/{brandId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get all users of a brand (Super Admin only)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brandIdstringRequired

Responses

200

Brand users retrieved successfully

No content

404

Brand not found

get

/admin/brands/{brandId}/users

HTTPcURLJavaScriptPython

GET /admin/brands/{brandId}/users HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add user to brand (Super Admin only)

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brandIdstringRequired

Responses

200

User added to brand successfully

No content

400

User already in brand

404

Brand or user not found

post

/admin/brands/{brandId}/add-user

HTTPcURLJavaScriptPython

POST /admin/brands/{brandId}/add-user HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove user from brand (Super Admin only)

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brandIdstringRequired

userIdstringRequired

Responses

200

User removed from brand successfully

No content

400

Cannot remove brand owner

404

Brand or user not found

delete

/admin/brands/{brandId}/remove-user/{userId}

HTTPcURLJavaScriptPython

DELETE /admin/brands/{brandId}/remove-user/{userId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update user role in brand (Super Admin only)

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brandIdstringRequired

userIdstringRequired

Responses

200

User role updated successfully

No content

400

Cannot update brand owner role

404

Brand or user not found

put

/admin/brands/{brandId}/update-user/{userId}

HTTPcURLJavaScriptPython

PUT /admin/brands/{brandId}/update-user/{userId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content