Users API

Users API primarily works with a user’s membership in a company space. Responses and validations therefore combine data from the global user and that user’s membership in the space.

Supported tasks

Task	Note
List users	Supports filtering by state and sync_status.
User detail	Can be looked up by internal ID or personal_id.
Create user	Creates active membership in the company space.
Update user	Changes user data and membership data.
Archive	Internally revokes the membership.
Restore	Returns revoked membership back to active use.

Identifiers

Integrations need to agree whether the primary identifier is:

• internal ID,
• personal_id,
• e-mail.

E-mail is readable, but it may not be stable. personal_id is often better for HR integrations.

Edge cases

• Archiving is not physical deletion.
• Changing full_name can affect other memberships of the same global user.
• Supervisor can be referenced by internal ID, personal_id, or e-mail.
• Last-owner validation protects the company space from losing its owner.