Skip to main content

Namely Python Client

Project description

namely

Non-official Python client for Namely

Learn more about Namely API here

Installation

pip install namely

Get started

# Import Namely API Client
from namely import Client

# Initialise Namely API Client
client = Client("https://<your-domain>.namely.com/api/v1/", "<your-namely-api-token>")

# Get all profiles
get_all = client.profiles.get_all(multi_threading=False)

# Get profile by Namely id
person = client.profiles.get("<person-namely-id>")

# Get my Namely profile
me = client.profiles.get_me()

# Get all profiles by filters
mikes = client.profiles.filter(first_name="Mike")

# Update profile by Namely id
profile_to_update = {"user_status": "inactive"}
updated_profile = client.profiles.update("<person-namely-id>", profile_to_update)

# Create Namely profile
new_profile = {
        "first_name": "John",
        "last_name": "Smith",
        "user_status": "active",
        "start_date": "2019-01-01",
        "email": "work@email.com"
        }
created_profile = client.profiles.create(new_profile)

License

The MIT License

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page