The article contains extended documentation about the CIX API. With the API, you can access all data on CIX necessary to build CIX readers, utilities etc.
The API uses a REST-like interface. This means that our CIX API method calls are made over the internet by sending HTTP GET or POST requests to the CIX API REST server . Nearly any computer language can be used to communicate over HTTP with the REST server.
| Method | Description |
|---|---|
| Forum.Details.get | Returns the title, description and other details related to the forum. |
| Forum.Moderators.get | Returns a list of the forum moderators. |
| Forum.Participants.get | Returns a list of the forum participants. |
| Forum.Topics.get | Returns a list of the forum topics. |
| Forum.TopicThreads.get | Returns a list of the threads in a topic. |
| Forum.TopicThread.get | Returns a thread from the topic. |
| Forum.Message.get | Returns an individual message. |
| Forum.MessageRoot.get | Gets the root ID for a message. |
| Forum.Message.post | Posts a new message or comment into a topic. |
| Forum.MessageCopy.post | Creates a copy of an existing message in a topic. |
| Forum.Withdraw.get | Withdraw a message from a topic. |
| Forum.PriorityToggle.get | Toggle whether a forum is marked as priority. |
| Forum.MarkReadForum.get | Mark a forum as read. |
| Forum.MarkReadTopic.get | Mark topic as read. |
| Forum.MarkReadThread.get | Mark a thread as read. |
| Forum.MarkReadMessage.get | Mark a message as read/unread. |
| Forum.Join.get | Join user to a forum. |
| Forum.Resign.get | Resign a user from a forum. |
| Forum.Search.post | Search the forums, use filters to restrict search scope. |
| Methods | Description |
|---|---|
| Directory.Categories.get | Get a list of the directory categories. |
| Directory.CategoryForums.get | Return a list of the forums in a directory category. |
| Directory.Search.post | Search the forum directory. |
| Method | Description |
|---|---|
| Mod.ForumNew.post | Create a new forum. |
| Mod.ForumUpdate.post | Edit forum properties. |
| Mod.TopicNew.post | Create a new forum topic. |
| Mod.TopicUpdate.post | Edit topic properties. |
| Mod.ModeratorAdd.get | Add a moderator to the forum. |
| Mod.ModeratorRem.get | Remove a moderator from the forum. |
| Mod.ParticipantAdd.get | Add a participant to a forum. |
| Mod.ParticipantRem.get | Remove a participant. |
| Mod.Rules.get | Get a list of rules for a specific forum. |
| Mod.RuleAdd.post | Add a forum rule. |
| Mod.RuleUpdate.post | Edit and existing forum rule. |
| Mod.RuleRem.get | Remove a forum rule. |
| Method | Description |
|---|---|
| User.Profile.get | Returns the current users profile information. |
| User.UserProfile.get | Returns the profile for a specified user. |
| User.Forums.get | Returns a list of forums the logged on user is joined to. |
| User.ForumTopics.get | Returns a list of forum topics for the logged on user. |
| User.Friends.get | Returns a list of friends for a user. |
| User.NextUnread.post | Returns a pointer to the users next unread message. |
| User.NextPriority.post | Returns a pointer to the users next unread priority message. |
| User.RecentPosts.get | Returns a list of the users last posts in open forums. |
| User.Mugshot.get | Returns the users mugshot as a stream. |
| User.CosySync.get | Syncronise the users pointers with CoSy. |
| User.ScratchPad.get | Get unread messaged for a custom client. |
| Method | Description |
|---|---|
| Alerts.get | Get a list of messages a user has an alert for. |
| Alerts.Remove.get | Remove a message from the alerts list. |
| Alerts.Add.post | Add a message to the alerts list. |
| Alerts.SetActive.get | Set an alert message as active/inactive. |
| Method | Description |
|---|---|
| Friends.get | Get a list of friends, with details. |
| Friends.Remove.get | Remove a friendship. |
| Friends.DetailsRem.get | Remove a relationship detail from a friendship. |
| Friends.DetailsAdd.post | Add a relationship detail to a friendship. |
| Friends.Requests.get | Get a list of requests made or recived by the user. |
| Friends.RequestMake.get | Add a friend request. |
| Friends.RequestRespond.get | Accept or decline a friend request. |
| Method | Description |
|---|---|
| Starred.get | Get a list of a users starred messages. |
| Starred.Add.post | Add a message to a users starred list. |
| Starred.Remove.get | Remove a message from a users starred list. |
| Method | Description |
|---|---|
| PMessage.get | Get a list of messages in a conversation. |
| PMessage.Add.post | Create a new conversation. |
| PMessage.Reply.post | Reply to an existing conversation. |
| PMessage.Inbox.get | Get a list of messages for users inbox. |
| PMessage.InboxRem.get | Remove a message stored in a users inbox. |
| PMessage.Inbox.ToggleRead.get | Mark a message read or unread. |
| PMessage.Outbox.get | Get a list of messages for users outbox. |
| PMessage.OutboxRem.get | Remove a message stored in a users outbox. |
| Method | Description |
|---|---|
| Tags.ByForum.get | Get a list of tags for a specified forum. |
| Tags.ByTopic.get | Get a list of tags for a specified forum/topic. |
| Tags.UserByForum.get | Get a list of the users tags for a specified forum. |
| Tags.UserByTopic.get | Get a list of the users tags for a specified forum/topic. |