Developer Center

Activities API

Last Updated: Feb 20, 2017 04:11PM CET

URL

/api/activities

Description

Allows you to retrieve the activity feed items.

Methods

GET Activities

Allows retrieving a list of activities entries within a date range that can be fitered by entity key.

Parameters

from From (start) date to retreive journal entries from.Required
to To (end) date to retreive the journal entries from.Required
clientID The client key to filter activities on.
groupID The group key to filter activities on.
centreID The centre key to filter activities on.
branchID The branch key to filter activities on.
loanProductID The loan product key to filter activities on.
savingsProductID The savings product key to filter activities on.
loanAccountID The loan account key to filter activities on.
savingsAccountID The savings account key to filter activities on.
userID The user key to filter activities on.

Usage examples

//get all activities within date range
    GET /api/activities?from=2012-06-01&to=2012-07-01

    //get all activities for client with encoded key 8a33ae49441c4fe101441c71497200e3 within date range
    GET /api/activities?from=2012-06-01&to=2012-07-01&clientID=8a33ae49441c4fe101441c71497200e3

    //get all activities for client with encoded key 8a33ae49441c4fe101441c71497200e3 within date range with pagination
    GET /api/activities?from=2012-06-01&to=2012-07-01&clientID=8a33ae49441c4fe101441c71497200e3&offset=0&limit=100

    //get all activities for group with encoded key 8a33ae49441c4fe101441c714972sze2 within date range
    GET /api/activities?from=2012-06-01&to=2012-07-01&groupID=8a33ae49441c4fe101441c714972sze2

Samples responses:

List of activity types:
  • Client activities
    • CLIENT_CREATED
    • CLIENT_COMMENT_ADDED
    • CLIENT_EDITED
    • CLIENT_DELETED
    • CLIENT_BRANCH_ASSIGNMENT
    • CLIENT_CENTRE_ASSIGNMENT
    • CLIENT_CENTRE_UNASSIGNMENT
    • CLIENT_CREDIT_OFFICER_UNASSIGNMENT
    • CLIENT_SET_TO_PENDIN
    • CLIENT_SET_TO_ACTIVE
    • CLIENT_SET_TO_INACTIVE
    • CLIENT_SET_TO_BLACKLISTED
    • CLIENT_SET_TO_EXITED
    • CLIENT_LINE_OF_CREDIT_CREATED
    • CLIENT_LINE_OF_CREDIT_EDITED
    • CLIENT_LINE_OF_CREDIT_REVOKED
    • SMS_MESSAGE_SENT
  • Portal activities
    • PORTAL_ACTIVATED
    • PORTAL_DEACTIVATE
    • PORTAL_EDITED
  • Group activities
    • CLIENT_JOINED_GROUP
    • CLIENT_LEFT_GROUP
    • GROUP_CREATED
    • GROUP_COMMENT_ADDED
    • GROUP_EDITED
    • GROUP_BRANCH_ASSIGNMENT
    • GROUP_BRANCH_UNASSIGNMENT
    • GROUP_CENTRE_ASSIGNMENT
    • GROUP_CENTRE_UNASSIGNMENT
    • GROUP_CREDIT_OFFICER_ASSIGNMENT
    • GROUP_CREDIT_OFFICER_UNASSIGNMENT
    • GROUP_LINE_OF_CREDIT_CREATED
    • GROUP_LINE_OF_CREDIT_EDITED
    • GROUP_LINE_OF_CREDIT_REVOKED
  • Branch activities
    • BRANCH_CREATED
    • BRANCH_COMMENT_ADDED
    • BRANCH_EDITED
  • Centre activities
    • CENTRE_CREATED
    • CENTRE_COMMENT_ADDED
    • CENTRE_EDITED
  • Loan product activities
    • LOAN_PRODUCT_CREATED
    • LOAN_PRODUCT_COMMENT_ADDE
    • LOAN_PRODUCT_EDITED
    • LOAN_PRODUCT_DEACTIVATED
    • LOAN_PRODUCT_ACTIVATED
    • LOAN_PRODUCT_DELETED
  • Loan account activities
    • LOAN_ACCOUNT_CREATED
    • LOAN_ACCOUNT_EDITED
    • LOAN_ACCOUNT_SET_TO_PARTIAL
    • LOAN_ACCOUNT_SET_TO_PENDING_APPROVAL
    • LOAN_ACCOUNT_SET_TO_APPROVED(TargetType.LOAN_ACCOUNT
    • LOAN_ACCOUNT_SET_TO_CLOSED_CANCELLED
    • LOAN_ACCOUNT_SET_TO_CLOSED_REJECTED
    • LOAN_ACCOUNT_SET_TO_CLOSED_RESCHEDULED
    • LOAN_ACCOUNT_SET_TO_CLOSED_WRITTEN_OFF
    • LOAN_ACCOUNT_SET_TO_ACTIVE
    • LOAN_ACCOUNT_DISBURSED
    • LOAN_ACCOUNT_SET_TO_IN_ARREARS
    • LOAN_ACCOUNT_DELETED
    • LOAN_GROUP_DELETED
    • LINKED_LOAN_ACCOUNT
    • UNLINKED_LOAN_ACCOUNT
    • LOAN_ACCOUNT_PAYED_OFF
    • LOAN_ACCOUNT_LOCKED
    • LOAN_ACCOUNT_UNLOCKED
    • LOAN_ACCOUNT_SET_TO_CLOSED_OBLIGATIONS_MET
    • LOAN_SCHEDULE_EDITED
  • Savings product activities
    • SAVINGS_PRODUCT_CREATED
    • SAVINGS_PRODUCT_COMMENT_ADDED
    • SAVINGS_PRODUCT_EDITED
    • SAVINGS_PRODUCT_ACTIVATED
    • SAVINGS_PRODUCT_DEACTIVATED
    • SAVINGS_PRODUCT_DELETED
  • Savings account activities
    • SAVING_ACCOUNT_CREATED
    • SAVING_ACCOUNT_EDITED
    • SAVINGS_ACCOUNT_APPROVED
    • SAVINGS_ACCOUNT_ACTIVATED
    • SAVINGS_ACCOUNT_CLOSED_WITHDRAWN
    • SAVINGS_ACCOUNT_CLOSED_REJECTED
    • SAVINGS_ACCOUNT_CLOSED
    • SAVINGS_ACCOUNT_MATURED
    • SAVINGS_ACCOUNT_SET_TO_PENDING
    • SAVINGS_ACCOUNT_MATURITY_SET
    • SAVINGS_ACCOUNT_MATURITY_UNSET
    • SAVINGS_ACCOUNT_SET_TO_ARREARS
    • SAVINGS_ACCOUNT_WRITEN_OFF
    • AVINGS_ACCOUNT_SET_TO_LOCKED
    • SAVINGS_ACCOUNT_DELETED
  • User activities
    • USER_CREATED
    • USER_EDITED
    • USER_DELETED
    • USER_COMMENT_ADDED
    • USER_LOGGED_IN
    • USER_BRANCH_ASSIGNMENT
    • USER_BRANCH_UNASSIGNMENT
  • Data migration activities
    • DATA_IMPORTED
    • DATA_IMPORT_APPROVED
    • DATA_IMPORT_REVERTED
  • Tasks activities
    • TASK_CREATED
    • TASK_EDITED
    • TASK_DELETED
    • TASK_COMPLETED
    • TASK_UNCOMPLETED
  • Documents activities
    • DOCUMENT_CREATED
    • DOCUMENT_EDITED
    • DOCUMENT_DELETED
  • GL Accounts activities
    • GLACCOUNT_CREATED
    • GLACCOUNT_EDITED
    • GLACCOUNT_DELETED
    • GLACCOUNTSCLOSURE_EXECUTED
    • GLACCOUNTSCLOSURE_UNDONE
//response containing a list of activities
[
   {
      "activity":{
         "encodedKey":"8a54e5b444441eba014445e18c640021",
         "transactionID":1656,
         "timestamp":"2014-02-18T16:43:33+0000",
         "type":"TASK_DELETED",
         "branchKey":"8a33ae49441c4fe101441c713b36000e",
         "userKey":"8a33ae49441c4fe101441c5fe42f0005",
         "assignedUserKey":"8a33ae49441c4fe101441c5fe42f0005",
         "notes":"Disburse your first loan",
         "fieldChanges":[

         ]
      },
      "branchName":"Matola City",
      "userName":"Max Power"
   },
   {
      "activity":{
         "encodedKey":"8a54e5b444441eba0144477140920028",
         "transactionID":1657,
         "timestamp":"2014-02-19T00:00:08+0000",
         "type":"LOAN_ACCOUNT_SET_TO_IN_ARREARS",
         "clientKey":"8a33ae49441c4fe101441c7149e00102",
         "loanProductKey":"8a33ae494420ac160144210c0be50152",
         "loanAccountKey":"8a42711a4430587d0144307a352d0001",
         "notes":"",
         "fieldChanges":[

         ]
      },
      "clientName":"Kwemto Akobundu",
      "loanProductName":"dynamic dbei horizontal",
      "loanAccountName":"dynamic dbei horizontal"
   },
   {
      "activity":{
         "encodedKey":"8a54e5b44449337f014449337f130000",
         "transactionID":1661,
         "timestamp":"2014-02-19T08:11:54+0000",
         "type":"USER_LOGGED_IN",
         "branchKey":"8a33ae49441c4fe101441c713b36000e",
         "userKey":"8a33ae49441c4fe101441c5fe42f0005",
         "assignedUserKey":"8a33ae49441c4fe101441c5fe42f0005",
         "notes":"",
         "fieldChanges":[

         ]
      },
      "branchName":"Matola City",
      "userName":"Max Power"
   },
   {
      "activity":{
         "encodedKey":"8a54e5b44449337f0144498ce4430004",
         "transactionID":1665,
         "timestamp":"2014-02-19T09:49:34+0000",
         "type":"USER_LOGGED_IN",
         "branchKey":"8a33ae49441c4fe101441c713b36000e",
         "userKey":"8a33ae49441c4fe101441c5fe42f0005",
         "assignedUserKey":"8a33ae49441c4fe101441c5fe42f0005",
         "notes":"",
         "fieldChanges":[

         ]
      },
      "branchName":"Matola City",
      "userName":"Max Power"
   },
   {
      "activity":{
         "encodedKey":"8a54e5b44449337f014449a978650005",
         "transactionID":1666,
         "timestamp":"2014-02-19T10:20:47+0000",
         "type":"CLIENT_EDITED",
         "clientKey":"8a33ae49441c4fe101441c71497200e3",
         "userKey":"8a33ae49441c4fe101441c5fe42f0005",
         "notes":"",
         "fieldChanges":[
            {
               "id":331,
               "fieldChangeName":"NAME",
               "originalValue":"Adaoha Samuel",
               "newValue":"Adaoha z Samuel"
            }
         ]
      },
      "clientName":"Adaoha z Samuel",
      "userName":"Max Power"
   }
]
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete