Users

Overview

Users endpoints provide discovery and profile access in the authenticated tenant context.

Endpoint Summary

Method	Route	Purpose
GET	/v2.3/users	List users
GET	/v2.3/users/current	Get current authenticated context
GET	/v2.3/users/{userId}	Get user by ID

GET /v2.3/users

Return paginated users visible for the authenticated context.

Headers

Header	Required	Value
Authorization	Yes	Bearer {{ACCESS_TOKEN}}
Accept	Yes	application/json

Query Parameters

Parameter	Type	Required	Description
page	number	No	Page number.
per_page	number	No	Items per page.
search_text	string	No	Search value.
status_id	number	No	Filter by status.
is_primary	boolean	No	Filter primary users.
order	string	No	Sort field.
order_direction	string	No	asc or desc.

Example Request

curl -X GET "{{BASE_URL}}/v2.3/users?page=1&per_page=20" \
  -H "Authorization: Bearer {{ACCESS_TOKEN}}" \
  -H "Accept: application/json"

Success Response (200)

{
  "success": true,
  "result": {
    "currentPage": 1,
    "perPage": 20,
    "lastPage": 1,
    "total": 2,
    "items": [
      {
        "id": 501,
        "first_name": "John",
        "last_name": "Manager",
        "name": "John Manager",
        "email": "[email protected]",
        "entity_id": 77,
        "entity_type": "entity",
        "is_primary": true,
        "phone": "",
        "phone_number": "",
        "phone_prefix": "",
        "profile_image": "",
        "status_id": 1,
        "status_name": "Active",
        "status_reason": "",
        "primary_image_path": "",
        "role": "owner",
        "role_name": "Owner",
        "role_id": 9,
        "admin_access": 0,
        "auid": 0,
        "confirmed_account": true,
        "company_position": "HR Lead",
        "last_login": "2026-04-29T08:10:11+00:00",
        "created_at": "2026-03-12T10:25:00+00:00",
        "updated_at": "2026-04-29T08:10:11+00:00",
        "platform": {
          "name": "marketplace",
          "url": "https://marketplace.example.com"
        },
        "timezone": "Europe/Bucharest",
        "role_type": "owner"
      }
    ],
    "filters": []
  }
}

GET /v2.3/users/current

Return the current authenticated context.

Headers

Header	Required	Value
Authorization	Yes	Bearer {{ACCESS_TOKEN}}
Accept	Yes	application/json

Example Request

curl -X GET "{{BASE_URL}}/v2.3/users/current" \
  -H "Authorization: Bearer {{ACCESS_TOKEN}}" \
  -H "Accept: application/json"

Success Response (200)

{
  "success": true,
  "result": {
    "id": 4200,
    "uuid": "11111111-2222-3333-4444-555555555555",
    "primary_image_path": "",
    "company_name": "Example Client Ltd",
    "slug": "example-client-ltd",
    "status_id": 3,
    "entity_type_id": 2,
    "entity_type": "client",
    "status_name": "Active",
    "status": "active",
    "status_reason": "",
    "company_type_id": 53,
    "company_type_name": "Limited Liability Company",
    "profile_picture": "",
    "main_register": 0,
    "created_at": "2026-01-13 09:56:24",
    "company_legal_name": "",
    "no_of_ratings": 0,
    "hubspot_id": null,
    "rating": [],
    "default_legal_entity": {
      "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "owner_id": "11111111-2222-3333-4444-555555555555",
      "name": "Example Client Ltd",
      "country_code": "DE",
      "region": "Berlin",
      "city": "Berlin",
      "address": "Example Street 10",
      "tax_number": "DE123456789",
      "zip_code": "10115",
      "segments": []
    },
    "industry_id": 54,
    "industry_name": "Technology",
    "number_of_employees_id": 55,
    "number_of_employees_name": "1-3",
    "no_of_orders": 12,
    "currency_id": 978,
    "currency_code": "EUR",
    "parent_company": "Example Group"
  }
}

GET /v2.3/users/{userId}

Return user details by identifier.

Headers

Header	Required	Value
Authorization	Yes	Bearer {{ACCESS_TOKEN}}
Accept	Yes	application/json

Path Parameters

Parameter	Type	Required	Description
userId	number	Yes	User identifier.

Example Request

curl -X GET "{{BASE_URL}}/v2.3/users/{{USER_ID}}" \
  -H "Authorization: Bearer {{ACCESS_TOKEN}}" \
  -H "Accept: application/json"

Success Response (200)

{
  "success": true,
  "result": {
    "id": 501,
    "first_name": "John",
    "last_name": "Manager",
    "name": "John Manager",
    "email": "[email protected]",
    "entity_id": 4200,
    "entity_type": "client",
    "is_primary": true,
    "phone": "700000000",
    "phone_number": "700000000",
    "phone_prefix": "+40",
    "profile_image": "",
    "status_id": 3,
    "status_name": "Active",
    "status_reason": "Entity status updated",
    "primary_image_path": null,
    "role": "client",
    "role_name": "Mobility Admin",
    "role_id": 3,
    "admin_access": 0,
    "auid": 0,
    "confirmed_account": true,
    "company_position": "Operations Manager",
    "last_login": null,
    "created_at": "2026-01-13T09:56:26.000000Z",
    "updated_at": "2026-03-17T00:00:04.000000Z",
    "platform": {
      "name": "client",
      "url": "http://localhost:4202/"
    },
    "timezone": "Europe/Bucharest",
    "role_type": "client",
    "uuid": "99999999-8888-7777-6666-555555555555",
    "entity_uuid": "11111111-2222-3333-4444-555555555555",
    "phone_country": "RO",
    "status": "active",
    "user_id": 501,
    "company": {
      "id": 4200,
      "uuid": "11111111-2222-3333-4444-555555555555",
      "slug": "example-client-ltd",
      "entity_type_id": 2,
      "entity_type": "client",
      "status": "active",
      "status_id": 3,
      "status_name": "Active",
      "company_name": "Example Client Ltd",
      "company_legal_name": "",
      "company_type_id": 53,
      "company_type_name": "Limited Liability Company",
      "primary_image_path": "",
      "default_legal_entity": {
        "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "owner_id": "11111111-2222-3333-4444-555555555555",
        "name": "Example Client Ltd",
        "country_code": "DE",
        "region": "Berlin",
        "city": "Berlin",
        "address": "Example Street 10",
        "tax_number": "DE123456789",
        "zip_code": "10115",
        "segments": []
      }
    }
  }
}