# Get All Groups of organization

Returns a list of all groups within an organization

Endpoint: GET /api/v2.0/orgs/{orgToken}/groups
Version: 3.0.1
Security: bearer-key

## Query parameters:

  - `pageSize` (string)
    Enter the number of items to return in each page of the result.

  - `page` (string)
    Enter the page number to display in the result. Page numbers start at 0

  - `search` (any)
    Filter your search to return items whose property has a specific value.
Use the syntax:  where a colon (:) separates between property, operation and value.
+ Property: the name of the property of the item
+ Operation:
    +  - true if the value is identical to this value.
    +  - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3
    +  - true if the property's value is contained within this value
    +  - true if this regular expression resolves as true.
        The regex is not case sensitive, and special characters must be escaped with a backslash.
        Special characters include space, double quote ("), '', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.
        To pass an escaped character in a URL in Postman, encode it first.
        E.g. to return all items whose value begins with  or , use regex:^a
+ Value: the value of the property.

To combine multiple filters, separate each filter with a semicolon with no space. E.g.  property1:operation1:value1;property2:operation2:value2

This endpoint supports filtering on the following properties and its supported operators:
+ contextType:equals:value
+ name:[like | equals | regex]:value
+ product:in:value1,value2,value-n
+ roles:in:value1,value2,value-n

  - `sort` (any)
    Sort search results alphabetically on an item's property by entering  followed by the property name.
E.g. enter  to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. .

You can sort by the following properties:
+ accountStatus
+ contextType
+ name
+ product
+ role
+ users

  - `optionalColumns` (string)
    Used to add group roles information to the response
    Enum: "roles"

## Path parameters:

  - `orgToken` (string, required)
    org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App:  tab > ).

## Response 200 fields (application/json):

  - `additionalData` (object)
    + : The total count of data points returned in an API response.
+ : Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.
    Example: {"totalItems":"422","isLastPage":"true"}

  - `supportToken` (string)
    Example: "1171c60d"

  - `retVal` (array)

  - `retVal.uuid` (string)
    Example: "123e4567-e89b-12d3-a456-426655440000"

  - `retVal.name` (string)
    Example: "Group A"

  - `retVal.description` (string)
    Example: "Group description"

  - `retVal.users` (integer)
    The amount of users in that group
    Example: 22

  - `retVal.affectedProducts` (integer)
    Example: 5

  - `retVal.roles` (array)

  - `retVal.roles.contextToken` (string)
    Depending on the value of contextType, this can be:
+ orgToken (org UUID by running Entities - Organization > Get User Organization) or Api Token (from the Mend SCA App:  tab > ).
+ productToken (product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App:  tab > .
+ projectToken (project UUID by running Entities - Product > Get Product Projects) or project Token (from the Mend SCA App:  tab > ).
    Example: "123e4567-e89b-12d3-a456-426655440000"

  - `retVal.roles.contextName` (string)
    Example: "My Project"

  - `retVal.roles.contextType` (string)
    Type of entity the role will be associated with
    Enum: "orgs", "products"

  - `retVal.roles.role` (string)
    Enum: "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER"

## Response 400 fields (*/*):

  - `supportToken` (string)
    Example: "1171c60d"

## Response 403 fields (*/*):

  - `supportToken` (string)
    Example: "1171c60d"