Skip to main content

Overview

Unify provides an official Python library that makes it easy to interact with the Unify API from your code. The library handles authentication, request formatting, and response parsing so you can focus on building your integration.
The Python library source code is available on GitHub.

Quick start

You can install the Unify Python library with your preferred package manager:
Generate an API key in Settings → Developers and then initialize the client:
The Python library reads the UNIFY_API_KEY environment variable by default. If the variable is set, you can omit the api_key parameter when initializing the client.

Usage

Retrieve all objects in your Unify workspace to see what’s available:
Python
Retrieve the attributes defined on a specific object to understand its schema:
Python
Use the upsert endpoint to create a new record or update an existing one based on a unique attribute. This is the recommended approach for syncing data into Unify because it handles deduplication automatically.
Python
Running this again with updated attributes (for example, a new title) will update the existing record rather than creating a duplicate, because email is used as the match key.
If you know the value of a unique attribute (like an email address), you can look up the record directly without needing the record ID:
Python

Next steps

Send records via API

Send data from external tools and systems via API.

Data API reference

Explore the full Data API reference.