ProjectMembers and Groups

The list of Persons associated with a Project, and Groups of Persons.

Operations

Get Groups

Request

Get the list of Groups for a Project. This endpoint has no features for filtering or sorting the groups; all groups are returned.

Security

OAuth2(Required scopes: read)

Bodyapplication/json

filterProjectIdstring(CompactUUID)^[0-9a-fA-F]{32}$

The UUID of a single Project.

Example:"8e8aa42241794371ae9d0ed7b67a8c86"

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/groups/select \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filterProjectId": "8e8aa42241794371ae9d0ed7b67a8c86"
  }'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

Bodyapplication/json

statusstringrequired

Value:"success"

dataArray of objects(Group)required

metadataobject(ResponseMetadata)required

Present on every JSON response. For non-paginated operations, page will be 1, total_pages will be 1, and total_records equal to the number of elements in data.

Response

{
  "status": "success",
  "data": [
    { … },
    { … }
  ],
  "metadata": {
    "timestamp": "2024-11-04T10:30:00Z",
    "correlation_id": "abc-123",
    "page": 1,
    "total_pages": 1,
    "total_records": 2
  }
}