/groups
Returns a list of Group objects.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Headers
X-Account-Token
Token identifying the end user.
Query parameters
created_after
If provided, will only return objects created after this datetime.
created_before
If provided, will only return objects created before this datetime.
cursor
The pagination cursor value.
expand
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_deleted_data
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_data
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_commonly_used_as_team
If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
modified_after
If provided, only objects synced by Merge after this date time will be returned.
modified_before
If provided, only objects synced by Merge before this date time will be returned.
names
If provided, will only return groups with these names. Multiple values can be separated by commas.
page_size
Number of results to return per page. The maximum limit is 100.
remote_fields
Deprecated. Use show_enum_origins.
Allowed values:
remote_id
The API provider's ID for the given object.
show_enum_origins
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:
types
If provided, will only return groups of these types. Multiple values can be separated by commas.
Response
next
previous
results
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WcbVPiyhLHv0oqr+61UFT0uFp16xaCPLgSWcC9Z/fU1tSQNGFkMhNnJgKeOt/9Vp4Q92ztvbINRHmlhOQf8kt3T/f0JH/aLjXgSzW3L+yxYtou2YH0gNsXdlPJKLRLNg2ZQwPIdiCPx3bJ1lEYSmXAazDgnm4pGNkXdjkA5cN+JNiIgVeOdy8zYcBX1DApdHlx2P4oOc4u2ZyJCXhV15WRMD8TSnfcp+me332Mv9bGLtkh1dqMlYz8cQ8eItA/1Yx/D4cAhKF836OGlpeO31epwI+2xb/cAw4GvDo1tA4G3PgSs3ONjQn1Rbk8Bh4eJOc98OCxDKJMlWEuB10+rZwfn52f7mcqydn/TXz+r6O9+4ehHJ7tEd/lhEZ7nYE7cwbtqXPvnzi1k5nzdHfqPE2enPvJ4R7x6V5n0Dm9HXyp3NarR7c/2IH0f/v9/PNl/fLa2XOfrirO/ZepM3CPOgN3MnxqV66b7vS69WnmPH057tTvKs7g6vS6KY9uaz3dqfVkp3pwYJfs5TtpX/zx5/KGzEDO9JiNEjhL37UD6sMSlPQ+0JDth9GQM/dAVw5oQJ+koFN94MqgHIDHaLnLqRlJFWSipKtkCMrMyXH7Wfx5a6X/EFEFzxtOnv87Ov1AdPL1QSj8/N4xKRY3zr6wr5xW1ald1V9aUfWRMk6HHOwLoyL4m+nbF3/YEIRczgHiCxcxiZKtIJAGCPPskm3mIdjf4m0PEVPgdamiARhQ8cHf/ir9iGS13rXqV7V2vX3XwcFZrXdJHVzmsSgg/Y3CCKkCYYifBZSMTWzxLz+RkJrxd/B0NEwP1L9A0oGZsZog8EjGiqQJYjMkV7jk3p2Dd7W9O2dTJsM0cWUQSMHnJNLgEaqJARr8zbX+P/NZ1WL+I9VkJJULliOneCAXssSR0/+N1KkO2p+v3j5QzhkVLrRqSLEsHxpavVx6O+F9ncgMKGp16VxJzpEMMNHMrI7cSF+uHdcrOL0S0CUNhlK2ejhocrUXcO7DbYe6VSznUgE1Y0DikootYyGNL+df/fugAHjW7oU1eKJCgIVlZpne/maD1VbTr9qYKs6QzDET+85PdyAliS/ctGSIhzFWO97UqFkEgpzOsdw4Tz9SzQwiOWxNxWn9Zi0wC+HJUvIaVViunKmlY0rmzv7JcO6d3b2bLK42H4KqqgkSskyNjGfnt+HZtICYXsmnTtWUiaGc4QBayG14gP1VM6nTeVIU4kanXHUXonsdAKlIWtAD4LtA7ir5OfEUuNUCJXEgPovux6Lbccf1MWtQ10jFKJLJLeSKktUmHSASRQmgjUGVfKLRKq3cjRPVHUpzGzJSiRCGXSZa721mraFAj7O7ggEpl9uhCfImCFDMtfqNQReHop8qEj0yYV5PBdeV2WF7Y8XAj2srnNKpKaXPIWkq6JBiJXqpKlmobizO4Vajr2UZaYOUpuSDRCKZmx2LxXbBi1uUcZijj7ipLGn1doIhG8ohMr9YcifY9awal5GHg6/VI4lawTo4m6DYpcoIUFgcM7mCgVyNTTI2YvecE9H3Pci2ooBSgUQuE3sHBtUWOgTFzNzqKggYls/lpsVy+fdWc8UL9jhnWKnGQm6jJlWEHky71+5bNapd6iEVEbEiyRQL0ZdGAtWX/BGQcouFf+pEdJ0dvvX1Wq6jIETMt2I5N0m43lmsuo60meKlDQu5bcSqtcP6SDlnXoTEKlcrznztSkxgQnF4TGBCi8Ni/cYE4h55ZieRfGNL/2+oMcyNF521+zg0eKqYz3CNm9dfK5PW5nm8FgTQUMsAuS2eqxZwwHotn8h1kSJNIvWTUWkzC9G3mlp3mKukliNjXQmjqNWuI/XCYzXSrufed157uvE/Dda86n/txhf/4XMcRKlWweYH1j7c3Y5GzGUgDA7EhdwOZQy3E4MUAGOl4lYyr8Ui4Eb6DOlxt1ytuHhWNB5FXQ5pD8KK5yiFVaMhM5RbHSqonzwXbP2jVev8EwlkcsJ3h3GuDSisqb1U7b0x6tK5OwakVa6ZWFEWixUhd4uRSKQFPXmdkGoW1wRLdiTYQxRvAmHilxqolbAh9zDCRLM4Oci27bLBkPK7JbscsQIleSty4dJlBql+WMi9eE7xphkcNTxRAETbcW6QIQe01T2ZGqm6Lmj9hhY7rmSfoLQUDGsyMlPLrbMhP9Pm2c9mAHYjODLh3wqs2T0m/HbiK0Xunr+WEKfCo1hBMh8/UtEC0lnRjBTTAVaYC2Ox8abrj9UuW8ZvvsBKLjK1d9mk7CXH44BKf0u2UIJvovTaHKVHySNjpSM9Dq1MszjZwlYHvB4LQ84SBojxXGWqRPU+zCpD540tTFwNZZ/6eG/liMXI0mKyynB6ctYpgLWu3ecTjJgOn6BMBXOc7qzfdj/eFyZOrsSp2rX6UVL5pA9rIi14ean5onq9dH+XfuOwAI2w7To6aIq9AiDVLIxB/rITj2kIWAaZaJG6AhoM4ocas6b1I22MjHdZnJi4Oi2Wng5p2nMhV5wcZ+0GN1DMAaTCY6CYALM71Kz4eZ0sDmESJEe7wPDuY9PqYr2k4u5jsziz6FuZIs5wLr3s9Lnxjc2YePT80+Hp+oeQTdpiD6iHND23RMoH2vrw0C2AVW419YutEn32MxMt2ttVtgr6K3DkHmWsWADzXXsM+CrHErV+jgWz+vkNvzTp21//BdJtpNtYYgAA" />