MojoTxt API

Developer Guide – v1

API URLs

Any API endpoint can be accessed with either HTTP GET or POST. Objects that are associated with a phone number require the phone number as part of the URL, which must be expressed in international format (i.e. “+13305551212”).

Objects that require a phone number use this URL scheme:

https://app.mojotxt.com/api/v1/{phone_number}/{object}/{verb}/{parameter}

https://app.mojotxt.com/api/v1/{object}/{verb}/{parameter}

Authentication

Objects

Results

Example Successful API Call:

GET https://app.mojotxt.com/api/v1/+16146827117/donations/list?Sort=DonationID

{
   “result":"success",                     /* Test for "success" to determine a successful result.  */
   “timestamp":1445803296,                 /* The server's current UNIX timestamp.                  */
   “request”:                              /* The server will echo back all received parameters.    */
      {                                
         “phone":"+16146827117",           /* phone_number (sent in URL)                            */
         “object":"donations",             /* object (sent in URL)                                  */
         “verb":"list"                     /* verb (sent in URL)                                    */
         “Sort":"DonationID"               /* Sort parameter (sent in querystring)                  */
      },
   “record_count":1,                       /* The number of records in this result set.             */
   “records”: [                            /* An array containing the record(s) requested.          */
      {
         "DonationID":103,
         "Keyword":"give",
         "FundName":"General Fund”,
         "DefaultAmount":null,
         "RecurringScheduleID":0,
         "CCBFund":1
      }
   ]
}

Example Unsuccessful API Call:

GET https://app.mojotxt.com/api/v1/+16146827117/donations/get

{
   "result":"error",                                    /* "error" indicates a problem occured. */
   "error_code":1200,                                   /* the error code                       */
   "error_message":"No Donation object specified.",     /* a human-readable error message       */
   "timestamp":1445804872,                              /* the server's current UNIX timestamp  */
   "request":                                           /* all reveived parameters              */
      {     
         "phone":"+16146827117",
         "object":"donations",
         "verb":"get"
      }
}

Error Codes