IntegrationsApple businessActions
List Apple Business groups
List user groups from the Apple Business API.
groups.list · Apple Business · v1
Details
Scopes
apple.groups.read
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
page_size | integer | No | minimum 1; maximum 100 |
cursor | string | No | minLength 1; maxLength 512 |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
groups | array<object> | Yes | maxItems 100 |
groups[] | object | Yes | additionalProperties false |
groups[].id | string | Yes | minLength 1; maxLength 200 |
groups[].name | string | No | maxLength 512 |
groups[].group_type | string | No | maxLength 128 |
groups[].status | string | No | maxLength 128 |
groups[].total_member_count | integer | No | minimum 0 |
groups[].created_date_time | string | No | minLength 1; maxLength 64 |
groups[].updated_date_time | string | No | minLength 1; maxLength 64 |
next_cursor | string | No | minLength 1; maxLength 512 |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
}
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"name": {
"type": "string",
"maxLength": 512
},
"group_type": {
"type": "string",
"maxLength": 128
},
"status": {
"type": "string",
"maxLength": 128
},
"total_member_count": {
"type": "integer",
"minimum": 0
},
"created_date_time": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"updated_date_time": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"id"
]
},
"maxItems": 100
},
"next_cursor": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"groups"
]
}