For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
DeveloperAcademyCommunityStatus
    • Overview
    • API Credentials
    • Errors
    • Legacy & Deprecated APIs
  • Events API
    • Chat Markup
    • Rate Limits
    • Message Delivery
  • (Beta) Conversations API
  • Data API
    • GETList conversations
    • GETList interactions
    • GETList plugins calls
    • GETList Plugin Resources
    • GETList Users
  • Webhook Listeners
  • Content Gateway
    • Overview
    • Integration Strategies
    • Starter Code
    • Verifying Your Build
    • Connecting Your Gateway to Moveworks
    • Authentication
    • How Permissions Work
    • Common Pitfalls
    • Operational Guide
    • Errors
    • Supported MIME Types
  • Legacy Gateways
    • Authentication
    • Response Options
    • Field Types
    • Form Gateway Errors
DeveloperAcademyCommunityStatus
Data API

List interactions

||View as Markdown|
GET
/interactions
GET
/export/v1/records/interactions
$curl -G https://api.moveworks.ai/export/v1/records/interactions \
>     -H "Authorization: <apiKey>" \
>     --data-urlencode "$filter=user_id eq '123456'" \
>     --data-urlencode $select=id,created_time \
>     --data-urlencode "$orderby=user_id desc" \
>     -d $top=10 \
>     -d $skip=10 \
>     -d $count=true
1{
2  "@odata.context": "https://api.moveworks.ai/export/v1/records/$metadata#interactions",
3  "@odata.nextLink": "https://api.moveworks.ai/export/v1/records/interactions?$skiptoken=abcdefghijklmno",
4  "value": [
5    {
6      "id": "AbG1JsIP",
7      "conversation_id": "MdA951Y",
8      "user_id": "1812312452353242",
9      "actor": "user",
10      "platform": "slack",
11      "type": "INTERACTION_TYPE_FREE_TEXT",
12      "label": "file_ticket",
13      "parent_interaction_id": "AbG1JsIP",
14      "detail": {
15        "content": "Get me access to zoom",
16        "domain": "IT",
17        "entity": "Okta",
18        "type": "RESOURCE_TYPE_KNOWLEDGE",
19        "detail": "HELPFUL",
20        "resource_id": "98394cfcc31f1a90473f3bda05013170",
21        "file_types": [
22          ".pdf"
23        ]
24      },
25      "created_time": "2023-01-01T00:00:00Z",
26      "last_updated_time": "2023-01-01T00:00:00Z"
27    }
28  ]
29}
Retrieve all interactions occurring with the Moveworks AI Assistant.
Was this page helpful?
Previous

List plugins calls

Next
Built with

Authentication

Authorizationstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

$filterstringOptional
This option allows the client to filter the resource that is address by request URL
$selectstringOptional
This option allow the client to request a limited set of properties of an entity
$orderbystringOptional
This option allow the client to request resources in either ascending or descending order
$topintegerOptional
This option request the number of items to be included in the result
$skipintegerOptional
This query option requests the number of items in the queried collection that are to be skipped and not included in the result.
$countbooleanOptional
This option allows clients to request a count of the matching resources included with the resources in the result

Response

Successfully retrieved list of interactions
@odata.contextstring
URL to the metadata of the response.
@odata.nextLinkstring
URL to fetch the next set of results.
valuelist of objects

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error