Command Palette

Search for a command to run...

B
Request

Groups

Manage groups, centers, and group lending (JLG/GLIM) functionality

List groupsRetrieve a groupCreate a groupUpdate a groupDelete a groupActivate a groupAssociate clients to groupDisassociate clients from groupRetrieve group accountsList centersCreate a center
GET
/fineract-provider/api/v1/groups

List groups

Retrieves a list of all groups in the system.

Query Parameters

officeIdinteger

Filter by office

staffIdinteger

Filter by staff

namestring

Filter by name

Returns

200List of groups

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/groups/{groupId}

Retrieve a group

Gets detailed information about a specific group including members.

Path Parameters

groupIdintegerrequired

Group ID

Query Parameters

associationsstring

Include associations (clientMembers, activeClientMembers)

Returns

200Group details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/groups

Create a group

Creates a new group with specified members and settings.

Request Bodyrequired

Group details

namestring

Group name

officeIdinteger

Office ID

staffIdinteger

Assigned staff

centerIdinteger

Parent center ID

externalIdstring
activeboolean
activationDatestring
submittedOnDatestring
clientMembersarray

Client IDs to add as members

dateFormatstring
localestring

Returns

200Group created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name",
  "officeId": 1,
  "staffId": 1,
  "centerId": 1,
  "externalId": "sample_externalId",
  "active": true,
  "activationDate": "01 January 2024",
  "submittedOnDate": "01 January 2024",
  "clientMembers": [],
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
PUT
/fineract-provider/api/v1/groups/{groupId}

Update a group

Updates group information.

Path Parameters

groupIdintegerrequired

Group ID

Request Bodyrequired

Updated group details

namestring
staffIdinteger
externalIdstring

Returns

200Group updated

Request

curl
curl --request PUT \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name",
  "staffId": 1,
  "externalId": "sample_externalId"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
DELETE
/fineract-provider/api/v1/groups/{groupId}

Delete a group

Deletes a group. Only groups without active loans can be deleted.

Path Parameters

groupIdintegerrequired

Group ID

Returns

200Group deleted

Request

curl
curl --request DELETE \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "resourceId": 1,
  "changes": {}
}
POST
/fineract-provider/api/v1/groups/{groupId}?command=activate

Activate a group

Activates a pending group.

Path Parameters

groupIdintegerrequired

Group ID

Request Bodyrequired

Activation details

activationDatestring
dateFormatstring
localestring

Returns

200Group activated

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId?command=activate" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "activationDate": "01 January 2024",
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
POST
/fineract-provider/api/v1/groups/{groupId}?command=associateClients

Associate clients to group

Adds client members to an existing group.

Path Parameters

groupIdintegerrequired

Group ID

Request Bodyrequired

Client IDs to associate

clientMembersarray

Returns

200Clients associated

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId?command=associateClients" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "clientMembers": []
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
POST
/fineract-provider/api/v1/groups/{groupId}?command=disassociateClients

Disassociate clients from group

Removes client members from a group.

Path Parameters

groupIdintegerrequired

Group ID

Request Bodyrequired

Client IDs to remove

clientMembersarray

Returns

200Clients disassociated

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId?command=disassociateClients" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "clientMembers": []
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/groups/{groupId}/accounts

Retrieve group accounts

Gets summary of all accounts associated with a group.

Path Parameters

groupIdintegerrequired

Group ID

Returns

200Group accounts summary

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/groups/:groupId/accounts" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
GET
/fineract-provider/api/v1/centers

List centers

Retrieves a list of all centers (parent groups).

Query Parameters

officeIdinteger

Filter by office

staffIdinteger

Filter by staff

offsetinteger

Pagination offset

Returns

200List of centers

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/centers" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
POST
/fineract-provider/api/v1/centers

Create a center

Creates a new center to manage multiple groups.

Request Bodyrequired

Center details

namestring
officeIdinteger
staffIdinteger
externalIdstring
activeboolean
activationDatestring
submittedOnDatestring
groupMembersarray
dateFormatstring
localestring

Returns

200Center created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/centers" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name",
  "officeId": 1,
  "staffId": 1,
  "externalId": "sample_externalId",
  "active": true,
  "activationDate": "01 January 2024",
  "submittedOnDate": "01 January 2024",
  "groupMembers": [],
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}

Was this page helpful?