Groups Resource

Routes

name method path description
Get groups GET /api/v1/groups Retrieve all or some groups of your community.
Add group POST /api/v1/groups Add a new group to your community.
Delete group DELETE /api/v1/groups/{identifier} Delete the group based on their identifier. To do this, you need the externalId you gave the group when you created it or the id provided by Socie. You can also find the Socie id for the group in the community management via More -> Details.
Get group GET /api/v1/groups/{identifier} Return a specific group. To do this, you need the externalId you gave the group when you created it or the id provided by Socie. You can also find the Socie id for the group in the community management via More -> Details.
Update group PATCH /api/v1/groups/{identifier} Update the information for a single group.
Get group memberships GET /api/v1/groups/{groupIdentifier}/memberships Retrieve all or some memberships of a specific group. To do this, you need the externalId you gave the group when you created it or the id provided by Socie. You can also find the Socie id for the group in the community management via More -> Details.
Add group membership POST /api/v1/groups/{groupIdentifier}/memberships Add a new membership to the group.
Add group memberships POST /api/v1/groups/{groupIdentifier}/memberships/_bulk Add a multiple memberships to the group.
Update group memberships order PATCH /api/v1/groups/{groupIdentifier}/memberships/order Update the order of the group memberships in the group. You must supply an array of ids for all memberships in the new order. This causes orderNumber to be updated for all group memberships.
Delete group membership DELETE /api/v1/groups/{groupIdentifier}/memberships/{identifier} Delete the group membership based on their identifier. To do this, you need the externalId you gave the group membership when you created it or the id provided by Socie.
Get group membership GET /api/v1/groups/{groupIdentifier}/memberships/{identifier} Return a specific group membership. To do this, you need the externalId you gave the group membership when you created it or the id provided by Socie.
Update group membership PATCH /api/v1/groups/{groupIdentifier}/memberships/{identifier} Update the information for a single group membership.

Get groups

GET /api/v1/groups

Retrieve all or some groups of your community.

Request Parameters
name type description
X-API-Key header The API Key for your community.
limit query Use this parameter to limit the amount of objects returned. Check Pagination for more information.
skip query Use this parameter to skip some objects in the response. Check Pagination for more information.
sort query Use this parameter to sort the response on 1 of the fields listed under 'Possible Sort Fields'. Check Sorting for more information.
Possible Sort Fields
createdAt  modifiedAt  name 
Response Body
media type data type description
application/json ApiGroupsResponse (JSON)

Example

Request
GET /api/v1/groups
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : [ {
    "id" : "5bBePJwK9ycB1QnjOlot",
    "externalId" : "123456",
    "name" : "Board",
    "about" : "Our meetings are the first Tuesday of every month.",
    "color" : "#419BF9",
    "membershipCount" : 6,
    "isVisibleInApp" : true,
    "state" : "ARCHIVED",
    "createdAt" : "2021-04-23T18:25:43.511Z",
    "modifiedAt" : "2021-04-23T18:25:43.511Z"
  }, {
    "id" : "...",
    "externalId" : "...",
    "name" : "...",
    "about" : "...",
    "color" : "...",
    "membershipCount" : 12345,
    "isVisibleInApp" : true,
    "state" : "ARCHIVED",
    "createdAt" : "...",
    "modifiedAt" : "..."
  } ],
  "_links" : {
    "base" : "https://api.socie.nl",
    "next" : "/api/v1/members?skip=5&limit=5",
    "prev" : "/api/v1/members?skip=0&limit=5",
    "self" : "https://api.socie.nl/api/v1/members"
  },
  "limit" : 5,
  "skip" : 10,
  "size" : 1
}
Add group

POST /api/v1/groups

Add a new group to your community.

Request Parameters
name type description
X-API-Key header The API Key for your community.
Request Body
media type data type
application/json ApiGroupInput (JSON)
Response Body
media type data type description
application/json ApiInsertResponse (JSON)

Example

Request
POST /api/v1/groups
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "externalId" : "123456",
  "name" : "Board",
  "about" : "Our meetings are the first Tuesday of every month.",
  "color" : "#419BF9",
  "isVisibleInApp" : true
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "id" : "5bBePJwK9ycB1QnjOlot",
  "externalId" : "123456"
}
Delete group

DELETE /api/v1/groups/{identifier}

Delete the group based on their identifier. To do this, you need the externalId you gave the group when you created it or the id provided by Socie. You can also find the Socie id for the group in the community management via More -> Details.

Request Parameters
name type description
X-API-Key header The API Key for your community.
identifier path The identifier of the group you would like to delete.
key query Use externalId as the value to delete the group based on your own identifier.

Example

Request
DELETE /api/v1/groups/{identifier}
Content-Type: */*
X-API-Key: ...

                
...
Response
HTTP/1.1 204 No Content
Get group

GET /api/v1/groups/{identifier}

Return a specific group. To do this, you need the externalId you gave the group when you created it or the id provided by Socie. You can also find the Socie id for the group in the community management via More -> Details.

Request Parameters
name type description
X-API-Key header The API Key for your community.
identifier path The identifier of the group you would like to retrieve.
key query Use externalId as the value to retrieve the group based on your own identifier.
Response Body
media type data type description
application/json ApiGroupResponse (JSON)

Example

Request
GET /api/v1/groups/{identifier}
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : "5bBePJwK9ycB1QnjOlot",
  "externalId" : "123456",
  "name" : "Board",
  "about" : "Our meetings are the first Tuesday of every month.",
  "color" : "#419BF9",
  "membershipCount" : 6,
  "isVisibleInApp" : true,
  "state" : "ARCHIVED",
  "createdAt" : "2021-04-23T18:25:43.511Z",
  "modifiedAt" : "2021-04-23T18:25:43.511Z"
}
Update group

PATCH /api/v1/groups/{identifier}

Update the information for a single group.

Request Parameters
name type description
X-API-Key header The API Key for your community.
identifier path The identifier of the group you would like to update.
key query Use externalId as the value to update the group based on your own identifier.
Request Body
media type data type
application/json ApiGroupInput (JSON)
Response Codes
code condition
204 The group was updated successfully
Response Body
media type data type description
application/json NoContentResponse (JSON)

Example

Request
PATCH /api/v1/groups/{identifier}
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "externalId" : "123456",
  "name" : "Board",
  "about" : "Our meetings are the first Tuesday of every month.",
  "color" : "#419BF9",
  "isVisibleInApp" : true
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }
Get group memberships

GET /api/v1/groups/{groupIdentifier}/memberships

Retrieve all or some memberships of a specific group. To do this, you need the externalId you gave the group when you created it or the id provided by Socie. You can also find the Socie id for the group in the community management via More -> Details.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to retrieve.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
limit query Use this parameter to limit the amount of objects returned. Check Pagination for more information.
skip query Use this parameter to skip some objects in the response. Check Pagination for more information.
sort query Use this parameter to sort the response on 1 of the fields listed under 'Possible Sort Fields'. Check Sorting for more information.
Possible Sort Fields
createdAt  modifiedAt  orderNumber 
Response Body
media type data type description
application/json ApiGroupMembershipsResponse (JSON)

Example

Request
GET /api/v1/groups/{groupIdentifier}/memberships
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : [ {
    "id" : "5bBePJwK9ycB1QnjOlot",
    "externalId" : "123456",
    "memberId" : "5bBePJwK9ycB1QnjOlot",
    "memberExternalId" : "123456",
    "title" : "Director",
    "orderNumber" : 14,
    "role" : "ADMIN"
  }, {
    "id" : "...",
    "externalId" : "...",
    "memberId" : "...",
    "memberExternalId" : "...",
    "title" : "...",
    "orderNumber" : 12345,
    "role" : "..."
  } ],
  "_links" : {
    "base" : "https://api.socie.nl",
    "next" : "/api/v1/members?skip=5&limit=5",
    "prev" : "/api/v1/members?skip=0&limit=5",
    "self" : "https://api.socie.nl/api/v1/members"
  },
  "limit" : 5,
  "skip" : 10,
  "size" : 1
}
Add group membership

POST /api/v1/groups/{groupIdentifier}/memberships

Add a new membership to the group.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to add a membership to.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
Request Body
media type data type
application/json ApiGroupMembershipInput (JSON)
Response Body
media type data type description
application/json ApiInsertResponse (JSON)

Example

Request
POST /api/v1/groups/{groupIdentifier}/memberships
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "externalId" : "123456",
  "memberId" : "5bBePJwK9ycB1QnjOlot",
  "memberExternalId" : "123456",
  "title" : "Director"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "id" : "5bBePJwK9ycB1QnjOlot",
  "externalId" : "123456"
}
Add group memberships

POST /api/v1/groups/{groupIdentifier}/memberships/_bulk

Add a multiple memberships to the group.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to add memberships to.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
Request Body
media type data type
application/json ApiGroupMembershipsInput (JSON)
Response Body
media type data type description
application/json array of ApiInsertResponse (JSON)

Example

Request
POST /api/v1/groups/{groupIdentifier}/memberships/_bulk
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "groupMemberships" : [ {
    "externalId" : "123456",
    "memberId" : "5bBePJwK9ycB1QnjOlot",
    "memberExternalId" : "123456",
    "title" : "Director"
  }, {
    "externalId" : "...",
    "memberId" : "...",
    "memberExternalId" : "...",
    "title" : "..."
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "id" : "5bBePJwK9ycB1QnjOlot",
  "externalId" : "123456"
} ]
Update group memberships order

PATCH /api/v1/groups/{groupIdentifier}/memberships/order

Update the order of the group memberships in the group. You must supply an array of ids for all memberships in the new order. This causes orderNumber to be updated for all group memberships.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to retrieve.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
Request Body
media type data type
application/json ApiGroupMembershipsOrderInput (JSON)
Response Codes
code condition
204 The order was updated successfully
Response Body
media type data type description
application/json NoContentResponse (JSON)

Example

Request
PATCH /api/v1/groups/{groupIdentifier}/memberships/order
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "order" : [ {
    "id" : "5bBePJwK9ycB1QnjOlot",
    "externalId" : "123456"
  }, {
    "id" : "...",
    "externalId" : "..."
  } ]
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }
Delete group membership

DELETE /api/v1/groups/{groupIdentifier}/memberships/{identifier}

Delete the group membership based on their identifier. To do this, you need the externalId you gave the group membership when you created it or the id provided by Socie.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to retrieve.
identifier path The identifier of the group membership you would like to delete.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
key query Use externalId as the value to delete the group membership based on your own identifier.
Response Body
media type data type description
application/json NoContentResponse (JSON)

Example

Request
DELETE /api/v1/groups/{groupIdentifier}/memberships/{identifier}
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }
Get group membership

GET /api/v1/groups/{groupIdentifier}/memberships/{identifier}

Return a specific group membership. To do this, you need the externalId you gave the group membership when you created it or the id provided by Socie.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to retrieve.
identifier path The identifier of the group membership you would like to retrieve.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
key query Use externalId as the value to retrieve the group membership based on your own identifier.
Response Body
media type data type description
application/json ApiGroupMembershipResponse (JSON)

Example

Request
GET /api/v1/groups/{groupIdentifier}/memberships/{identifier}
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : "5bBePJwK9ycB1QnjOlot",
  "externalId" : "123456",
  "memberId" : "5bBePJwK9ycB1QnjOlot",
  "memberExternalId" : "123456",
  "title" : "Director",
  "orderNumber" : 14,
  "role" : "ADMIN"
}
Update group membership

PATCH /api/v1/groups/{groupIdentifier}/memberships/{identifier}

Update the information for a single group membership.

Request Parameters
name type description
X-API-Key header The API Key for your community.
groupIdentifier path The identifier of the group you would like to retrieve.
identifier path The identifier of the group membership. you would like to update.
groupsKey query Use externalId as the value to retrieve the group based on your own identifier.
key query Use externalId as the value to update the group membership based on your own identifier.
Request Body
media type data type
application/json ApiGroupMembershipPatchInput (JSON)
Response Codes
code condition
204 The group membership was updated successfully
Response Body
media type data type description
application/json NoContentResponse (JSON)

Example

Request
PATCH /api/v1/groups/{groupIdentifier}/memberships/{identifier}
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "title" : "Director"
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }