Retrieve group list via API

The group allows you to silo the various resources available to users.

How to retrieve the list of groups via API

This article details the operation of the endpoint for retrieving the list of all groups via API.

By calling the endpoint GET /v1/settings/groups we retrieve a list of all groups with, for each group:

• A id (a unique identification number)
• A name (the name of the group)

Some examples of uses

The group identifier is essential and will be required in various API requests. In particular, you'll be using it:

• In endpoint URLs: To access certain endpoints, particularly those in settings. for example:
  • List consents enabled on a group on the endpoint /settings/groups/{id}/optins
  • List senders activated on a group on the endpoint /groups/{id}/senders
• In the body of requests: For example, when creating a campaign via API
  • When creating a campaign on the endpoint /campaigns
  • When creating a list on the endpoint /lists
  • When creating content on the endpoint /content

Conclusion

The group is the key to which each account and resource has access.

Further reading:

• Creating a group