Skip to content

Connected Group

Connected Group is a special representation of actual Group that through its Services is attached to Connected Hub.

Operations

List Connected Groups

Request

Filters and returns Connected Groups for current Hub.
Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
archivedstring

Filters groups by archived status:

  • true - return only groups that were archived,
  • false - return only groups that were not archived,
  • all - return groups without filtering by archived status.
Default:"false"
Enum:"true""false""all"
deletedstring

Filters groups by deletion status:

  • true - return only groups that were deleted,
  • false - return only groups that were not deleted,
  • all - return groups without filtering by deleted status.
Default:"false"
Enum:"true""false""all"
qstring

String that filters groups to those containing the search string in:

  • name.
sort_propstring

Determines which property results should be sorted by.

Default:"position"
Enum:"position""created_at""updated_at"
sort_dirstring

Determines sorting direction.

Default:"asc"
Enum:"asc""desc"
pageinteger, >= 1

Requested page index.

Default:1
per_pageinteger, [ 1 .. 100 ]

A limit on the number of records to be returned.

Default:25
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/connected_groups?archived=true&deleted=true&q=string&sort_prop=position&sort_dir=asc&page=1&per_page=25&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
current_pageinteger, >= 1
Example:1
page_countinteger, >= 1
Example:4
per_pageinteger, [ 1 .. 100 ]
Example:25
totalinteger, >= 0
Example:1024
dataArray of objects
Response
{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}