Messages

openapi: 3.0.0 info: description: >- The API for viewing messages sent to consumer user. version: '0.0' title: Messages tags: - name: Messages servers: - url: 'https://banno.com' paths: "/a/mobile/api/v0/institutions/{institutionId}/users/{userId}/messages": get: tags: - Messages description: | Retrieves a list of messages that a user would have seen based on when they became an active user. Requires the "Manage security settings" permission parameters: - in: path name: institutionId description: Institution Id required: true schema: type: string format: uuid - in: path name: userId description: User ID required: true schema: type: string format: uuid - in: query name: since schema: type: string format: date-time - in: query name: until schema: type: string format: date-time - in: query name: limit schema: type: integer responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/messages" "404": description: Not found components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} schemas: messages: type: object properties: messages: type: array items: $ref: "#/components/schemas/message" message: type: object properties: messageId: type: string description: messageId format: uuid title: type: string example: Message Title description: type: string description: Stripped from message HTML example: Description createdAt: type: string description: Date and time message was created. format: date-time messageType: type: string enum: - Alert - User - Institution segmentId: type: string format: uuid description: Optional field - exists if institution message is targeted to a segment.