{
  "opencollection": "1.0.0",
  "info": {
    "name": "Vanilla Addons Conversations API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Conversations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List user conversations.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/conversations",
            "params": [
              {
                "name": "insertUserID",
                "value": "",
                "type": "query",
                "description": "Filter by author.\n"
              },
              {
                "name": "participantUserID",
                "value": "",
                "type": "query",
                "description": "Filter by participating user. (Has no effect if insertUserID is used)\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. See [Pagination](https://docs.vanillaforums.com/apiv2/#pagination).\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Desired number of items per page.\n"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Expand associated records using one or more valid field names. A value of \"all\" will expand all expandable fields.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "List user conversations."
        },
        {
          "info": {
            "name": "Add a conversation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://open.vanillaforums.com/api/v2/conversations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a conversation."
        },
        {
          "info": {
            "name": "Get a conversation.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/conversations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The conversation ID.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "Get a conversation."
        },
        {
          "info": {
            "name": "Leave a conversation.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://open.vanillaforums.com/api/v2/conversations/:id/leave",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The conversation ID.\n"
              }
            ]
          },
          "docs": "Leave a conversation."
        },
        {
          "info": {
            "name": "Get participants of a conversation.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/conversations/:id/participants",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The conversation ID.\n"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by participant status.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. See [Pagination](https://docs.vanillaforums.com/apiv2/#pagination).\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Desired number of items per page.\n"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Expand associated records using one or more valid field names. A value of \"all\" will expand all expandable fields.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "Get participants of a conversation."
        },
        {
          "info": {
            "name": "Add participants to a conversation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://open.vanillaforums.com/api/v2/conversations/:id/participants",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The conversation ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add participants to a conversation."
        },
        {
          "info": {
            "name": "List user messages.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/messages",
            "params": [
              {
                "name": "conversationID",
                "value": "",
                "type": "query",
                "description": "Filter by conversation.\n"
              },
              {
                "name": "insertUserID",
                "value": "",
                "type": "query",
                "description": "Filter by author.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. See [Pagination](https://docs.vanillaforums.com/apiv2/#pagination).\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Desired number of items per page.\n"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Expand associated records using one or more valid field names. A value of \"all\" will expand all expandable fields.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "List user messages."
        },
        {
          "info": {
            "name": "Add a message.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://open.vanillaforums.com/api/v2/messages",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a message."
        },
        {
          "info": {
            "name": "Get a message.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.vanillaforums.com/api/v2/messages/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The message ID.\n"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Only return fields with these keys from the output. Use dot notation for nested fields."
              }
            ]
          },
          "docs": "Get a message."
        }
      ]
    }
  ],
  "bundled": true
}