Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

factorial-api-client (Python)

Official Python SDK for the Factorial API.

Versioning

The SDK uses standard semver (MAJOR.MINOR.PATCH), independent of the Factorial API version date.

SDK version Factorial API version
1.x.y 2026-04-01
2.x.y 2026-07-01
3.x.y 2026-10-01

Factorial releases new API versions quarterly (Jan/Apr/Jul/Oct).

See the Factorial API versioning docs for details.

Installation

pip install factorial-api-client

Quick start

from factorial_api_client import FactorialClient

client = FactorialClient(api_key="YOUR_KEY")

# First page only
result = client.employees.employee.list()
employees = result.data

# Cursor-paginated iterator (sync)
for emp in client.employees.employee.paginate(max_items=100):
    print(emp.full_name)

# Collect all pages into a list
all_employees = client.employees.employee.all()

# Async iterator
import asyncio

async def main():
    async for emp in await client.employees.employee.paginate_async(max_items=100):
        print(emp.full_name)

asyncio.run(main())

Authentication

Pass your API key via api_key= or an OAuth2 bearer token via token=:

# API key (sent as x-api-key header)
client = FactorialClient(api_key="YOUR_KEY")

# OAuth2 bearer token
client = FactorialClient(token="YOUR_BEARER_TOKEN")

Environment variables

When an argument is omitted, the client falls back to environment variables. Explicit arguments always take precedence.

Variable Maps to Sent as
FACTORIAL_API_KEY api_key x-api-key header
FACTORIAL_TOKEN token Authorization: Bearer
FACTORIAL_BASE_URL base_url — (defaults to https://api.factorialhr.com)
# No arguments needed — reads FACTORIAL_API_KEY / FACTORIAL_TOKEN / FACTORIAL_BASE_URL
client = FactorialClient()

Error handling

The client fails loudly on non-2xx responses (bad/expired token, wrong base URL, 4xx/5xx) instead of silently returning None. These raise UnexpectedStatus:

from factorial_api_client.generated.errors import UnexpectedStatus

try:
    employees = client.employees.employee.list()
except UnexpectedStatus as e:
    print(e.status_code)  # e.g. 401
    print(e.content)      # raw response body (bytes)

Domain namespaces

The client is organised as client.{domain}.{resource}.{method}().

Domain Example
employees client.employees.employee.list()
ats client.ats.application.list()
attendance client.attendance.shift.list()
timeoff client.timeoff.leave.list()
contracts client.contracts.contract_version.list()
payroll client.payroll.supplement.list()
documents client.documents.document.list()
performance client.performance.review_process.list()
... 36 domains total

Available methods per resource: list, get, create, update, delete, paginate, paginate_async, all, plus any custom action endpoints.

Pagination

All list endpoints support cursor-based pagination via paginate() / paginate_async() / all():

# Stop after 50 items
for emp in client.employees.employee.paginate(max_items=50):
    ...

# Collect everything (use carefully on large datasets)
all_leaves = client.timeoff.leave.all()

High-volume retrieval

Pages are capped at 100 items — a server-side hard max (pagination docs); a larger limit has no effect. Cursor pagination is sequential, so all() on a large dataset issues one request per 100 records. For big pulls:

  • Filter with the endpoint's query params (date ranges, ids, employee_ids, …) instead of pulling everything.
  • Sync incrementally where updated_at-style filters exist, and cache locally.
  • Split one large query into filtered sub-queries (date windows, id chunks) and run them concurrently with paginate_async() — faster wall-clock, same total request count, so mind rate limits.
  • Pass max_items as a safety cap.

There is no server-side aggregation endpoint; compute totals client-side.

Webhooks

Manage subscriptions through the client, and type your handler payloads with the generated webhook catalog (re-exported from the package root).

from factorial_api_client import (
    FactorialClient,
    AtsApplicationCreateWebhook,
    WEBHOOK_CATALOG,
    WEBHOOK_PAYLOAD_TYPES,
)

client = FactorialClient(api_key="YOUR_KEY")

# Subscribe to an event. The `challenge` is a secret you choose; Factorial echoes
# it back in the `x-factorial-wh-challenge` header on every delivery so you can
# verify the request really came from Factorial.
client.api_public.webhook_subscription.create(body={
    "subscription_type": "ats/application/create",
    "target_url": "https://example.com/webhooks/factorial",
    "company_id": 55,
    "challenge": "a-random-secret-you-generate",
})

# Type a handler directly
def on_application_created(payload: AtsApplicationCreateWebhook) -> None:
    print(payload.id)

# Look up the payload model class for a subscription_type at runtime
model_cls = WEBHOOK_PAYLOAD_TYPES["ats/application/create"]
print(len(WEBHOOK_CATALOG), "webhook events available")

Factorial delivers the resource object at the top level of the POST body (no {type, data} envelope). A full event→payload reference and an SDK usage guide for coding agents are available as a skill:

npx skills add https://github.com/factorialco/factorial-api-sdks --skill factorial-api-sdks

Metadata

Release files for factorial-api-client 4.0.0b2027010125

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for factorial-api-client 4.0.0b2027010125
File Size Uploaded Provenance Actions
factorial_api_client-4.0.0b2027010125.tar.gz 680.3 kB Without provenance Details for factorial_api_client-4.0.0b2027010125.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for factorial-api-client 4.0.0b2027010125
File Interpreter ABI Platform Actions
factorial_api_client-4.0.0b2027010125-py3-none-any.whl Python 3 none any Details for factorial_api_client-4.0.0b2027010125-py3-none-any.whl

Total release size: 3.1 MB

Release files / factorial_api_client-4.0.0b2027010125.tar.gz

Download URL factorial_api_client-4.0.0b2027010125.tar.gz
Size 680.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b8c756d2b5e2772386c4a7b8b738539aad8aaec2ced35a146fcb434ffbff1e8b
BLAKE2b-256 checksum
How to use checksums
cf7ec778af07b1b10cfe7a1c9076753355338568f4b4aea0e22a5959a916abba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / factorial_api_client-4.0.0b2027010125-py3-none-any.whl

Download URL factorial_api_client-4.0.0b2027010125-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0a414b4ca3d5a0f4df1cb37f9f35e0352abbf64fe07f537fd8e792387203f339
BLAKE2b-256 checksum
How to use checksums
75a49d768513785809c58bf966f671f0b240ffc43bdcd940b542a0ce88116f92
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for factorial-api-client 4.0.0b2027010125

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page