{ "opencollection": "1.0.0", "info": { "name": "Arthur Conversations API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.arthuronline.co.uk/oauth/authorize", "accessTokenUrl": "https://auth.arthuronline.co.uk/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "List Assets on Conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/conversations/:conversation_id/assets", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Arthur conversation id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of assets associated with the given conversation ID." } ] }, { "info": { "name": "Messages", "type": "folder" }, "items": [ { "info": { "name": "List Messages Related To Conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/conversations/:conversation_id/messages", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Arthur conversation id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of messages related to a conversation id ." }, { "info": { "name": "Add Messages Related To Conversation", "type": "http" }, "http": { "method": "POST", "url": "https://api.arthuronline.co.uk/v2/conversations/:conversation_id/messages", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Arthur conversation id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to add a new message related to a  conversation . The API will return the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\nmessage \n It's done \n String \n Yes" }, { "info": { "name": "View Message Related To Conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/conversations/:conversation_id/messages/:message_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Arthur conversation id." }, { "name": "message_id", "value": "", "type": "path", "description": "Arthur message id." } ] }, "docs": "This API endpoint retrieves the details of a single message, identified by its unique  message_id .\n\nUse this endpoint to view the specific details of a message within a conversation." } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "List Conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/conversations/:conversation_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "Arthur conversation id." }, { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This endpoint retrieves a list of conversations." } ] } ], "bundled": true }