--- title: "ZeyOS REST API Reference" description: "Endpoints of the ZeyOS REST API, grouped by resource." canonical_url: "https://www.zeyos.com/api" markdown_url: "https://www.zeyos.com/ai/guide/api.md" section: "api-reference" authority: "reference" language: "en" source_repository: "https://cloud.zeyos.com/__doc/openapi/api.json" source_sha256: "f5850c6fa6f99a1b518fc8ddc4e566070b53b5506cde57a3299948d38fc6363c" --- # ZeyOS REST API Reference Endpoints of the ZeyOS REST API, grouped by resource. Each page lists its operations. - [accounts](https://www.zeyos.com/ai/openapi/tag.accounts.md): Accounts (6 endpoints) - [actionsteps](https://www.zeyos.com/ai/openapi/tag.actionsteps.md): Action Steps (6 endpoints) - [addresses](https://www.zeyos.com/ai/openapi/tag.addresses.md): Addresses (6 endpoints) - [applicationassets](https://www.zeyos.com/ai/openapi/tag.applicationassets.md): Application Assets *(developer read-only)* (3 endpoints) - [applications](https://www.zeyos.com/ai/openapi/tag.applications.md): Applications *(developer read-only)* (3 endpoints) - [appointments](https://www.zeyos.com/ai/openapi/tag.appointments.md): Appointments (6 endpoints) - [associations](https://www.zeyos.com/ai/openapi/tag.associations.md): Associations (6 endpoints) - [binfiles](https://www.zeyos.com/ai/openapi/tag.binfiles.md): Bin Files *(read-only)* (1 endpoints) - [campaigns](https://www.zeyos.com/ai/openapi/tag.campaigns.md): Campaigns (6 endpoints) - [categories](https://www.zeyos.com/ai/openapi/tag.categories.md): Categories (6 endpoints) - [channels](https://www.zeyos.com/ai/openapi/tag.channels.md): Channels (6 endpoints) - [comments](https://www.zeyos.com/ai/openapi/tag.comments.md): Comments (6 endpoints) - [components](https://www.zeyos.com/ai/openapi/tag.components.md): Components (6 endpoints) - [contacts](https://www.zeyos.com/ai/openapi/tag.contacts.md): Contacts (6 endpoints) - [contacts2contacts](https://www.zeyos.com/ai/openapi/tag.contacts2contacts.md): Contacts-to-contacts (6 endpoints) - [contracts](https://www.zeyos.com/ai/openapi/tag.contracts.md): Contracts (6 endpoints) - [couponcodes](https://www.zeyos.com/ai/openapi/tag.couponcodes.md): Coupon Codes (6 endpoints) - [coupons](https://www.zeyos.com/ai/openapi/tag.coupons.md): Coupons (6 endpoints) - [customfields](https://www.zeyos.com/ai/openapi/tag.customfields.md): Custom Fields *(read-only)* (3 endpoints) - [davservers](https://www.zeyos.com/ai/openapi/tag.davservers.md): DAV Servers (6 endpoints) - [devices](https://www.zeyos.com/ai/openapi/tag.devices.md): Devices (6 endpoints) - [documents](https://www.zeyos.com/ai/openapi/tag.documents.md): Documents (6 endpoints) - [dunning](https://www.zeyos.com/ai/openapi/tag.dunning.md): Dunning Notices (6 endpoints) - [dunning2transactions](https://www.zeyos.com/ai/openapi/tag.dunning2transactions.md): Dunning-to-transactions (6 endpoints) - [entities2channels](https://www.zeyos.com/ai/openapi/tag.entities2channels.md): Entities-to-channels (6 endpoints) - [events](https://www.zeyos.com/ai/openapi/tag.events.md): Events (6 endpoints) - [feedservers](https://www.zeyos.com/ai/openapi/tag.feedservers.md): Feed Servers (6 endpoints) - [files](https://www.zeyos.com/ai/openapi/tag.files.md): Files (6 endpoints) - [follows](https://www.zeyos.com/ai/openapi/tag.follows.md): Follows (6 endpoints) - [forks](https://www.zeyos.com/ai/openapi/tag.forks.md): Forks *(restricted read-only)* (3 endpoints) - [general](https://www.zeyos.com/ai/openapi/tag.general.md): General (2 endpoints) - [groups](https://www.zeyos.com/ai/openapi/tag.groups.md): Groups *(restricted read-only)* (3 endpoints) - [groups2users](https://www.zeyos.com/ai/openapi/tag.groups2users.md): Groups-to-users *(admin read-only)* (3 endpoints) - [invitations](https://www.zeyos.com/ai/openapi/tag.invitations.md): Invitations (6 endpoints) - [items](https://www.zeyos.com/ai/openapi/tag.items.md): Items (6 endpoints) - [ledgers](https://www.zeyos.com/ai/openapi/tag.ledgers.md): Ledgers (6 endpoints) - [likes](https://www.zeyos.com/ai/openapi/tag.likes.md): Likes (6 endpoints) - [links](https://www.zeyos.com/ai/openapi/tag.links.md): Links (6 endpoints) - [mailinglists](https://www.zeyos.com/ai/openapi/tag.mailinglists.md): Mailing Lists (6 endpoints) - [mailingrecipients](https://www.zeyos.com/ai/openapi/tag.mailingrecipients.md): Mailing Recipients (6 endpoints) - [mailservers](https://www.zeyos.com/ai/openapi/tag.mailservers.md): Mail Servers (6 endpoints) - [messagereads](https://www.zeyos.com/ai/openapi/tag.messagereads.md): Message-reads (6 endpoints) - [messages](https://www.zeyos.com/ai/openapi/tag.messages.md): Messages (6 endpoints) - [notes](https://www.zeyos.com/ai/openapi/tag.notes.md): Notes (6 endpoints) - [objects](https://www.zeyos.com/ai/openapi/tag.objects.md): Custom Objects (6 endpoints) - [opportunities](https://www.zeyos.com/ai/openapi/tag.opportunities.md): Opportunities (6 endpoints) - [participants](https://www.zeyos.com/ai/openapi/tag.participants.md): Participants (6 endpoints) - [payments](https://www.zeyos.com/ai/openapi/tag.payments.md): Payments (6 endpoints) - [permissions](https://www.zeyos.com/ai/openapi/tag.permissions.md): Permissions *(admin read-only)* (3 endpoints) - [pricelists](https://www.zeyos.com/ai/openapi/tag.pricelists.md): Price Lists (6 endpoints) - [pricelists2accounts](https://www.zeyos.com/ai/openapi/tag.pricelists2accounts.md): Pricelists-to-accounts (6 endpoints) - [prices](https://www.zeyos.com/ai/openapi/tag.prices.md): Prices (6 endpoints) - [projects](https://www.zeyos.com/ai/openapi/tag.projects.md): Projects (6 endpoints) - [records](https://www.zeyos.com/ai/openapi/tag.records.md): Records (6 endpoints) - [relateditems](https://www.zeyos.com/ai/openapi/tag.relateditems.md): Related Items (6 endpoints) - [resources](https://www.zeyos.com/ai/openapi/tag.resources.md): Resources *(developer read-only)* (3 endpoints) - [services](https://www.zeyos.com/ai/openapi/tag.services.md): Services *(developer read-only)* (3 endpoints) - [stocktransactions](https://www.zeyos.com/ai/openapi/tag.stocktransactions.md): Stock Transactions (6 endpoints) - [storages](https://www.zeyos.com/ai/openapi/tag.storages.md): Storages (6 endpoints) - [suppliers](https://www.zeyos.com/ai/openapi/tag.suppliers.md): Suppliers (6 endpoints) - [tasks](https://www.zeyos.com/ai/openapi/tag.tasks.md): Tasks (6 endpoints) - [tickets](https://www.zeyos.com/ai/openapi/tag.tickets.md): Tickets (6 endpoints) - [transactions](https://www.zeyos.com/ai/openapi/tag.transactions.md): Transactions (6 endpoints) - [users](https://www.zeyos.com/ai/openapi/tag.users.md): Users *(restricted read-only)* (3 endpoints) - [weblets](https://www.zeyos.com/ai/openapi/tag.weblets.md): Weblets *(developer read-only)* (3 endpoints)