# Ziik.io API docs

## Docs

- [Introduction](https://docs.ziik.io/index.md): Welcome to the Ziik API docs. You can use the API to access Ziik API endpoints, fetching and supplying data from your Ziik system.
- [Authentication](https://docs.ziik.io/pages/authentication.md): To authorize, you will need to authenticate with the service to get an access token for use with the API.
- [Best practices](https://docs.ziik.io/pages/best-practices.md): Common best practices for using REST APIs effectively and reliably.
- [Entity overview](https://docs.ziik.io/pages/structure.md): The entities in the Ziik space.
- [Pagination](https://docs.ziik.io/pages/pagination.md): How list endpoints return paginated data with links and meta.
- [Error handling](https://docs.ziik.io/pages/errorhandling.md): ?
- [Sync Ziik users with your own system](https://docs.ziik.io/pages/sync-users.md): Two-way sync using the reference field to link Ziik users to your external system.
- [Managing units](https://docs.ziik.io/pages/managing-units.md): Create, read, update, and delete units (departments, locations, teams) via the API.
- [Managing unit memberships](https://docs.ziik.io/pages/managing-unit-memberships.md): Assign users to units and manage department and user types per membership.
- [Authenticate](https://docs.ziik.io/api-reference/auth/authenticate.md): Authenticate with email and password. Returns a JWT.
- [Renew token](https://docs.ziik.io/api-reference/auth/renew-token.md): Exchange the current JWT for a fresh token. Requires a valid (possibly expiring) JWT in the Authorization header.
- [Get multiple posts by ID](https://docs.ziik.io/api-reference/posts/get-multiple-posts-by-id.md): Returns a map of requested content IDs to post objects (or null if not accessible).
- [Get a post](https://docs.ziik.io/api-reference/posts/get-a-post.md): Returns a single post with all related data.
- [Delete a post](https://docs.ziik.io/api-reference/posts/delete-a-post.md): Deletes a post.
- [Update a post](https://docs.ziik.io/api-reference/posts/update-a-post.md): Updates an existing post.
- [Create a post](https://docs.ziik.io/api-reference/posts/create-a-post.md): Creates a new post and returns the created resource.
- [List post IDs by user](https://docs.ziik.io/api-reference/posts/list-post-ids-by-user.md): Returns an ordered list of post IDs shared with or authored by a specific user.
- [List global post IDs](https://docs.ziik.io/api-reference/posts/list-global-post-ids.md): Returns an ordered list of post IDs for the global feed, filtered and sorted by type and sorting.
- [List post IDs by group](https://docs.ziik.io/api-reference/posts/list-post-ids-by-group.md): Returns an ordered list of post IDs for a specific group feed, filtered by type and sorting.
- [Get counters](https://docs.ziik.io/api-reference/counters/get-counters.md): Get notification and conversation counters for the authenticated user
- [List groups](https://docs.ziik.io/api-reference/groups/list-groups.md): Returns a paginated list of groups visible to the authenticated user. The list can be filtered by membership mode, group type and sorting method.
- [Create a group](https://docs.ziik.io/api-reference/groups/create-a-group.md): Creates a new group and adds the authenticated user as an admin member.
- [Get a group](https://docs.ziik.io/api-reference/groups/get-a-group.md): Returns details about a single group. Private groups are only accessible to members.
- [Delete a group](https://docs.ziik.io/api-reference/groups/delete-a-group.md): Soft deletes a group and schedules background cleanup of associated content from feeds.
- [Update a group](https://docs.ziik.io/api-reference/groups/update-a-group.md): Updates the basic details of an existing group.
- [Search groups](https://docs.ziik.io/api-reference/groups/search-groups.md): Searches groups by name and returns a paginated list of matching groups visible to the authenticated user.
- [List languages](https://docs.ziik.io/api-reference/languages/list-languages.md): Get list of enabled languages keyed by abbreviation
- [List timezones](https://docs.ziik.io/api-reference/timezones/list-timezones.md): Get list of timezones
- [List units](https://docs.ziik.io/api-reference/units/list-units.md): Returns a paginated list of units. Can be filtered by feature, user membership, and search keyword.
- [Create unit](https://docs.ziik.io/api-reference/units/create-unit.md): Creates a new unit and returns the created resource.
- [List basic units](https://docs.ziik.io/api-reference/units/list-basic-units.md): Returns a list of units with only basic information (id and name).
- [Get unit by ID](https://docs.ziik.io/api-reference/units/get-unit-by-id.md): Returns a single unit with related data.
- [Delete unit](https://docs.ziik.io/api-reference/units/delete-unit.md): Deletes a unit.
- [Update unit](https://docs.ziik.io/api-reference/units/update-unit.md): Updates an existing unit.
- [Get unit by reference](https://docs.ziik.io/api-reference/units/get-unit-by-reference.md): Returns a single unit resolved by its reference value.
- [List user unit memberships](https://docs.ziik.io/api-reference/user-unit-memberships/list-user-unit-memberships.md): Returns all unit memberships (unit, department, user types) for the given user.
- [Add unit membership](https://docs.ziik.io/api-reference/user-unit-memberships/add-unit-membership.md): Creates or updates a unit membership for the user (unit, department, user types). Returns the membership and sets Location header.
- [Remove unit membership](https://docs.ziik.io/api-reference/user-unit-memberships/remove-unit-membership.md): Deletes a unit membership for the user. User must have at least one remaining membership.
- [Update unit membership](https://docs.ziik.io/api-reference/user-unit-memberships/update-unit-membership.md): Updates an existing unit membership for the user (e.g. department, user types, or move to another unit).
- [Get users](https://docs.ziik.io/api-reference/users/get-users.md)
- [Post users](https://docs.ziik.io/api-reference/users/post-users.md)
- [Get user by ID](https://docs.ziik.io/api-reference/users/get-user-by-id.md): Get user by ID
- [Get user by reference](https://docs.ziik.io/api-reference/users/get-user-by-reference.md)
- [Get collection of users by IDs](https://docs.ziik.io/api-reference/users/get-collection-of-users-by-ids.md)
- [Delete user](https://docs.ziik.io/api-reference/users/delete-user.md): Delete a user by ID
- [Update user](https://docs.ziik.io/api-reference/users/update-user.md): Update a user by ID
- [Deactivate user](https://docs.ziik.io/api-reference/users/deactivate-user.md): Deactivate a user by ID
- [Reactivate user](https://docs.ziik.io/api-reference/users/reactivate-user.md): Reactivate a user by ID
- [User birthdays](https://docs.ziik.io/api-reference/users/user-birthdays.md): Get users with birthdays in range
- [List user types](https://docs.ziik.io/api-reference/user-types/list-user-types.md): Returns user types (roles) visible to the authenticated user.
- [Create user type](https://docs.ziik.io/api-reference/user-types/create-user-type.md): Creates a new user type (role) with optional name and reference.
- [List basic user types](https://docs.ziik.io/api-reference/user-types/list-basic-user-types.md): Returns a minimal list of user types (id and name) for the current website.
- [Get user type](https://docs.ziik.io/api-reference/user-types/get-user-type.md): Returns a single user type by ID, including permissions and distinct user count.
- [Delete user type](https://docs.ziik.io/api-reference/user-types/delete-user-type.md): Deletes a user type. Fails if any users are assigned to this role.
- [Update user type](https://docs.ziik.io/api-reference/user-types/update-user-type.md): Updates an existing user type. Can change name and reference.
- [List conversations](https://docs.ziik.io/api-reference/conversations/list-conversations.md): Returns a paginated list of conversations for the authenticated user. Can be filtered by status (normal, unread, archived), keyword (title or participant name), or exact participant set. Supports pagination via limit and page.
- [Create conversation with first message](https://docs.ziik.io/api-reference/conversations/create-conversation-with-first-message.md): Creates a new conversation (or uses existing one) with the given recipients and immediately adds the first message. Returns the created message resource.
- [Get a conversation](https://docs.ziik.io/api-reference/conversations/get-a-conversation.md): Returns a single conversation by ID with participants, latest message, and related data. Requires view permission on the conversation.
- [Delete a conversation](https://docs.ziik.io/api-reference/conversations/delete-a-conversation.md): Deletes the conversation. Only conversation admins can delete; other participants may leave instead. Executes full conversation deletion (messages, participants, etc.) for the current website.
- [Update a conversation](https://docs.ziik.io/api-reference/conversations/update-a-conversation.md): Updates conversation properties. Currently supports setting the conversation title; a system message is added to the conversation when the title is changed. Requires manage permission on the conversation.
- [Create a conversation](https://docs.ziik.io/api-reference/conversations/create-a-conversation.md): Creates a new conversation or returns an existing one with the given recipients. For a single recipient, finds or creates a direct conversation. For multiple recipients, creates a group conversation.
- [Archive a conversation](https://docs.ziik.io/api-reference/conversations/archive-a-conversation.md): Archives the conversation for the authenticated user and adds it to their blacklist so it no longer appears in the default list. The user must be a participant.
- [Unarchive a conversation](https://docs.ziik.io/api-reference/conversations/unarchive-a-conversation.md): Removes the archive flag for the authenticated user and removes the conversation from their blacklist so it appears again in the default list. The user must be a participant.
- [List messages in a conversation](https://docs.ziik.io/api-reference/conversations/list-messages-in-a-conversation.md): Returns a cursor-paginated list of messages for the given conversation. Supports loading around a specific starter message, text search, and bi-directional cursor pagination.
- [Create a new message in a conversation](https://docs.ziik.io/api-reference/conversations/create-a-new-message-in-a-conversation.md): Creates a new message in the given conversation for the authenticated user. Supports attaching files and replying to a parent message.
- [Get a single message in a conversation](https://docs.ziik.io/api-reference/conversations/get-a-single-message-in-a-conversation.md): Returns a single message in the given conversation with all related data (author, files, reactions, parent message, etc.).
- [Delete a message in a conversation](https://docs.ziik.io/api-reference/conversations/delete-a-message-in-a-conversation.md): Soft-deletes a message in the given conversation (marks as deleted, removes reactions, files, and voice data) and broadcasts the deletion to other participants.
- [Update a message in a conversation](https://docs.ziik.io/api-reference/conversations/update-a-message-in-a-conversation.md): Updates the text of an existing message in the given conversation. Important: see also Finalize message update
- [Finalize message update](https://docs.ziik.io/api-reference/conversations/finalize-message-update.md): Should be called by the client after all edit operations are complete. This broadcasts updates to conversation participants and returns the final message resource.

## OpenAPI Specs

- [openapi](https://docs.ziik.io/openapi.yaml)

## Optional

- [Contact us](https://www.ziik.io/contact-us)
- [Helpcenter](https://help.ziik.io/)
- [Blog](https://www.ziik.io/blog)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.