Include archived groups in `/groups/v2/tags/` endpoint

[jmezzera]

Related Product Which product is this question related to? Groups

Describe the question Im trying to get a list of groups, both active and archived, tagged with a specific tag.

What have you tried that worked? I had partial success with the endpoint /groups/v2/tags/:id/groups. It's returning a list with the active groups.

What have you tried that didn't work? As part of the response meta, the endpoint claims to support the following query params:

    "can_query_by": [
      "archive_status",
      "name"
    ],

/groups/v2/tags/:id/groups?where[archive_status]=archived yields the same response as /groups/v2/tags/:id/groups?where[archive_status]=active. Am I doing anything wrong?

Additional context /groups/v2/tags/:id/groups?where[name]=foo works as expected?

I have..

• [x] Reviewed the documentation found at https://developer.planning.center/docs
• [x] Searched for previous issues answering this question
• [x] Removed all private information from this issue (credentials, tokens, emails, phone numbers, etc.)
• [x] Reviewed my issue for completeness

[americanmouths]

Hi @jmezzera, thanks for bringing this to our attention. The archive_status query can be used with values of not_archived, only and include. not_archived will return only active groups, only will return only archived groups and include will include both active and archived groups.

It appears that this is not documented so I will work on getting that fixed! I'm going to close this issue but let us know if you need anything else.

[jmezzera]

Awesome! That did the trick!!

Thanks for the reply