Enlivy gives you full control over your organization’s users via the API.

Whether you’re building your own user interface or automating user workflows, the Enlivy API allows you to list, view, create, and update users with precision and flexibility.

Each user in Enlivy belongs to an organization and can have specific roles and statuses depending on their access level.

By using the following endpoints, you can manage your user base programmatically, integrate Enlivy into your internal systems, or automate user provisioning and onboarding processes.

This section covers the essential operations:

  • List all users
  • Retrieve details of a specific user
  • Add a new user
  • Edit an existing user’s details

List All Users

Returns a list of users in your organization, with support for filtering and pagination.

bash 
GET /organizations/{organizationId}/users

Request Headers

bash 
Authorization: Bearer
Content-Type: application/json

  • page number

    Page number for pagination.

    Default: 1

  • limit number

    Number of invoices per page.

    Default: 20

  • include string

    Comma-separated list of related data to include in the response.

    Examples: invoice_prefix , line_items , taxes , tag_ids

  • include_meta string

    Type of metadata to include alongside the response data.

    Examples: navigation , totals

Example

javascript 
const organizationId = "your_org_id";
const token = "YOUR_TOKEN_HERE";

fetch(`https://api.enlivy.com/organizations/{organizationId}/users?page=1&limit=20&include=tag_ids,user_role&include_meta=navigation`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  }
})

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json 
{
  "data": [
    {
      "id": "org_user_dummyid1234567890",
      "organization_id": "org_dummyorgid1234567890",
      "organization_user_role_id": "org_userrole_dummyroleid123456",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "phone_number": null,
      "phone_number_country_code": null,
      "country_code": "US",
      "address_line_1": "123 Main St",
      "address_county": "Sample County",
      "address_iso_3166": "US-CA",
      "locale": "en",
      "timezone": "America/Los_Angeles",
      "user_role": {},
      "tag_ids": []
    }
  ],
  "meta": {
    "navigation": {
      "active": 16,
      "trash": 1
    },
    "pagination": {
      "total": 16,
      "count": 16,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Get Single User

Retrieves detailed information about a specific user within an organization by their user ID.

bash 
GET /organizations/{organizationId}/users/{userId}

Request Headers

bash 
Authorization: Bearer
Content-Type: application/json

  • include string

    Comma-separated list of related data to include in the response.

    Examples: invoice_prefix , line_items , taxes , tag_ids

Example

javascript 
const organizationId = "your_org_id";
const userId = "user_12345";
const token = "YOUR_TOKEN_HERE";

fetch(`https://api.enlivy.com/organizations/${organizationId}/users/${userId}?include=tag_ids,user_role`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  }
})

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json 
{
  "data": {
    "id": "org_user_dummyid1234567890",
    "organization_id": "org_dummyorgid1234567890",
    "organization_user_role_id": "org_userrole_dummyroleid123456",
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone_number": null,
    "phone_number_country_code": null,
    "country_code": "US",
    "address_line_1": "123 Main St",
    "address_county": "Sample County",
    "address_iso_3166": "US-CA",
    "locale": "en",
    "timezone": "America/Los_Angeles",
    "user_role": {},
    "tag_ids": []
  }
}

Add an User

Allows you to programmatically add a new user to your organization. It supports setting roles, localization, and address details to streamline onboarding or account provisioning.

bash 
POST /organizations/{organizationId}/users

Request Headers

bash 
Authorization: Bearer
Content-Type: application/json

  • organization_user_role_id string

    Role assigned to the user within the organization.

  • first_name string

    User’s first name.

  • last_name string

    User’s last name.

  • locale string

    Language or localization code (e.g., ro).

  • country_code string

    Two-letter ISO country code (e.g., RO).

  • address_city string

    City where the user is located.

  • address_county string

    County or region associated with the user.

  • address_line_1 string

    Street address of the user.

  • address_iso_3166 string

    ISO 3166-2 subdivision code (e.g., RO-B).

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json 
{
  "data": {
    "id": "org_user_dummy_id",
    "organization_id": "org_dummy_org_id",
    "organization_user_role_id": "org_userrole_dummy_role_id",
    "name": "John Smith",
    "first_name": "John",
    "last_name": "Smith",
    "country_code": "RO",
    "address_line_1": "Str. 1",
    "address_city": "SECTOR1",
    "address_county": "București",
    "address_iso_3166": "RO-B",
    "locale": "ro",
    "timezone": "Europe/Bucharest"
  }
}

Edit an User

Allows you to programmatically add a new user to your organization. It supports setting roles, localization, and address details to streamline onboarding or account provisioning.

bash 
PUT /organizations/{organizationId}/users

Request Headers

bash 
Authorization: Bearer
Content-Type: application/json

  • organization_user_role_id string

    Role assigned to the user within the organization.

  • first_name string

    User’s first name.

  • last_name string

    User’s last name.

  • locale string

    Language or localization code (e.g., ro).

  • country_code string

    Two-letter ISO country code (e.g., RO).

  • address_city string

    City where the user is located.

  • address_county string

    County or region associated with the user.

  • address_line_1 string

    Street address of the user.

  • address_iso_3166 string

    ISO 3166-2 subdivision code (e.g., RO-B).

Request Response

This is just a preview, additional fields may appear depending on organization settings.

json 
{
  "data": {
    "id": "org_user_dummy_id",
    "organization_id": "org_dummy_org_id",
    "organization_user_role_id": "org_userrole_dummy_role_id_updated",
    "name": "Johnny Smith",
    "first_name": "Johnny",
    "last_name": "Smith",
    "country_code": "RO",
    "address_line_1": "Str. 2",
    "address_city": "SECTOR 2",
    "address_county": "București",
    "address_iso_3166": "RO-B",
    "locale": "ro",
    "timezone": "Europe/Bucharest"
  }
}