Integrations and APIs - Database Synchronization APIs


CivicReady
®

Fetching Data

Overview

With Membership API you can retrieve data from the CivicReady system at any time and send it to your database. This allows you to reconcile any data not in your database that users may have added to the CivicReady system.

You will be able to retrieve user changes within a given time period, admin permissions, groups, total network membership, and more.

To Fetch the Member Data XML Format
   
Fetching Users on a Network  
   
Fetching all members for the Network API URL:  https://regroup.com/api/v2/users?api_key=NetworkAPIKEY
   
Fetching the members not belonging to any groups API URL: https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&groupID=null
   
Fetch users associated to a specific campus https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&campusName=CampusCodedName
Fetch users associated to several campuses https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&campusName=CampusCodedName1,CampusCodedName2
Fetch users not associated to any campus https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&campusName=null
   
Fetching the members at the Group Level: https://regroup.com/groups/group-coded-name/api/v2/users?api_key=NetworkAPIKEY
Fetching the users associated to a specific campus at the Group Level: https://regroup.com/groups/group-coded-name/api/v2/users?api_key=NetworkAPIKEY&campusName=CampusCodedName1
Fetching the users associated toseveral campuses at the Group Level: https://regroup.com/groups/group-coded-name/api/v2/users?api_key=NetworkAPIKEY&campusName=CampusCodedName1,CampusCodedName2
Fetching the users not associated to any campus at the Group Level: https://regroup.com/groups/group-coded-name/api/v2/users?api_key=NetworkAPIKEY&campusName=null
   
CURL example to fetch members the two commands below will return the data in XML format):
   
Fetching the members at the Group Level API URL: curl -X GET https://regroup.com/groups/group-coded-name/api/v2/users?api_key=NetworkAPIKEY
   
Fetching all members for the Network Level members fetch API URL:  curl -X GET https://regroup.com/api/v2/users?api_key=NetworkAPIKEY
   
   
If you want the data in JSON Format please use /users.json instead /users in the URL: curl -X GET https://regroup.com/groups/group-coded-name/api/v2/users.json?api_key=NetworkAPIKEY
   
   
Fetch the Specific Member by single email https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&email=user1test1@email.com
Fetch the members by multiple emails https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&email=user1test1@email.com,user2test2@email.com
Fetch Specific Member by database id https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&databaseID=USER1TEST1DBID
Fetch members by multiple database ids https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&databaseID=USER1TEST1DBID,USER2TEST2DBID
Fetch Specific Member by User ID https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&userID=user1test1
Fetch members by multiple User IDs https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&userID=user1test1,user2test2
   
   
Fetch admins based on permission level  
Fetch network admins https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&networkAdmins=true
Fetch group admins https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&groupAdmins=true
Fetch limited admins https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&limitedAdmins=true
Fetch authorized senders https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&authorizedSenders=true
   
Fetch members by adding limit key  
Fetch limited members (pulls the first 100 members alphabetically by first name) https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&limit=100
   
Fetching all members for the Network that have updated their account on the Regroup website within a given time frame (hours): 
   
Fetches all members who have updated their account on the Regroup Website https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&hours=24
   
Custom Field requests API  
   
Fetching members by Custom Field https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&customField=department
Fetching members by Custom Field and Custom Field Value https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&customField=department&customFieldValue=science
Fetching members by Custom Field Value https://regroup.com/api/v2/users?api_key=NetworkAPIKEY&customFieldValue=science
   
Fetching groups on the Network:  
   
Fetch all the campuses from the network https://regroup.com/api/v2/campuses?api_key=NetworkAPIKEY
   
Fetched the details of particular campus in the network https://regroup.com/api/v2/campuses?api_key=NetworkAPIKEY&campusName=CampusCodedName
   
Fetching groups on the Network:  
   
   
Fetch groups https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY
   
Fetch default groups https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&defaultGroup=true
   
Fetch groups by category https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&categoryID=2
   
Fetch groups associated to a specific campus https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&campusName=CampusCodedName
Fetch groups associated to several campuses https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&campusName=CampusCodedName1,CampusCodedName2
Fetch groups not associated to any campus https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&campusName=null
   
Fetching unsubscribed members   
Fetch all unsubscribed members at network level https://regroup.com/api/v2/group_unsubscriptions?api_key=NetworkAPIKEY
Fetch all unsubscribed members by group using group id https://regroup.com/api/v2/group_unsubscriptions?api_key=NetworkAPIKEY&groupID=GROUPID1
Fetch all unsubscribed members by group using multiple group ids https://regroup.com/api/v2/group_unsubscriptions?api_key=NetworkAPIKEY&groupID=GROUPID1, GROUPID2
   
Fetching members by phone number:  
Fetch members by a phone number https://regroup.com/api/v2/phone_numbers?api_key=NetworkAPIKEY&phone=15551234567
   
Group pending requests API  
Fetch all group pending requests https://regroup.com/api/v2/group_membership_requests?api_key=NetworkAPIKEY
   
Pending Topic requests API  
Fetch all pending topic requests https://regroup.com/api/v2/pending_topic_requests?api_key=NetworkAPIKEY

For more information on how you can add this new feature to your network please contact CivicReady Support via email.

?



I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow