IntegrationsApple businessActions
List Apple Business users
List users from the Apple Business API.
users.list · Apple Business · v1
Details
Scopes
apple.users.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 |
users | array<object> | Yes | maxItems 100 |
users[] | object | Yes | additionalProperties false |
users[].id | string | Yes | minLength 1; maxLength 200 |
users[].first_name | string | No | maxLength 512 |
users[].last_name | string | No | maxLength 512 |
users[].email | string | No | maxLength 320 |
users[].managed_apple_account | string | No | maxLength 320 |
users[].status | string | No | maxLength 128 |
users[].department | string | No | maxLength 512 |
users[].job_title | string | No | maxLength 512 |
users[].employee_number | string | No | maxLength 128 |
users[].created_date_time | string | No | minLength 1; maxLength 64 |
users[].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": {
"users": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"first_name": {
"type": "string",
"maxLength": 512
},
"last_name": {
"type": "string",
"maxLength": 512
},
"email": {
"type": "string",
"maxLength": 320
},
"managed_apple_account": {
"type": "string",
"maxLength": 320
},
"status": {
"type": "string",
"maxLength": 128
},
"department": {
"type": "string",
"maxLength": 512
},
"job_title": {
"type": "string",
"maxLength": 512
},
"employee_number": {
"type": "string",
"maxLength": 128
},
"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": [
"users"
]
}