FAfactorialhr
Posts > Group

Reads all Groups

Changed on
What does it do?

These endpoints will allow you to retrieve groups

What can you do with groups?

Increase visibility and communication within the company by creating events and announcements. You can create groups for different departments, teams, or projects.

Who can use it?

For having this funcionality available, you need to have Communities V2 feature enabled.

get/api/2026-10-01/resources/posts/groups

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/posts/groups
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: posts
    • or API key in header x-api-key

Query parameters

ids[]string[]

identifier of the group.

[
  "1",
  "2",
  "3"
]
searchstring

search term to filter groups by title or description.

Example:announcements

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "title": "Company announcements",
      "description": "The place to find all company announcements."
    }
  ]
}

Changes