Skip to main content

List Governance Groups

GET 

/workgroups

This API returns list of Governance Groups

Request

Query Parameters

    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    limit int32

    Possible values: <= 50

    Default value: 50

    Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information.

    Example: 50
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, in, sw

    name: eq, sw, in

    Example: name sw "Test"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: name, created, modified, id, description

    Example: name,-modified

Responses

List of Governance Groups

Schema
  • Array [
  • owner object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's display name.

    id string

    Governance group ID.

    name string

    Governance group name.

    description string

    Governance group description.

    memberCount int64

    Number of members in the governance group.

    connectionCount int64

    Number of connections in the governance group.

  • ]
Loading...