Go to appAcademyWhat's new?
Back
Artisan IMG > Microsoft Teams (microsoft-teams) (bad148f4-14cf-4c91-b2ca-fe10dcd00cf3)
Microsoft Teams
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Add member to group
Copy

Adds a member to an Office 365 group (unified), a dynamic group or security group.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "user_id": "87654321-4321-4321-4321-210987654321"
4
}

Sample Output

1
{
2
    "success": true
3
}

Add owner to group
Copy

Adds an owner of an Office 365 group (unified), a dynamic group or security group.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "user_id": "87654321-4321-4321-4321-210987654321"
4
}

Sample Output

1
{
2
    "success": true
3
}

Add tab to channel
Copy

Adds a tab to a channel.

Sample Input

1
{
2
    "app_id": "12345678-90ab-cdef-ghij-klmnopqrstuv",
3
    "group_id": "87654321-fedc-ba09-8765-432109876543",
4
    "channel_id": "19:abcdef0123456789@thread.tacv2",
5
    "display_name": "Project Tracker",
6
    "configuration": {
7
        "entity_id": "projectTracker123",
8
        "content_url": "https://example.com/project-tracker",
9
        "remove_url": "https://example.com/remove-tab",
10
        "website_url": "https://example.com/project-tracker-web"
11
    }
12
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#teams('87654321-fedc-ba09-8765-432109876543')/channels('19:abcdef0123456789@thread.tacv2')/tabs/$entity",
3
    "id": "01234567-89ab-cdef-0123-456789abcdef",
4
    "displayName": "Project Tracker",
5
    "webUrl": "https://teams.microsoft.com/l/tab/01234567-89ab-cdef-0123-456789abcdef?label=Project+Tracker&tenantId=98765432-10fe-dcba-9876-543210fedcba",
6
    "configuration": {
7
        "entityId": "projectTracker123",
8
        "contentUrl": "https://example.com/project-tracker",
9
        "removeUrl": "https://example.com/remove-tab",
10
        "websiteUrl": "https://example.com/project-tracker-web"
11
    }
12
}

Archive team
Copy

Archives a team (makes it read-only).

Sample Input

1
{
2
    "team_id": "19:1c3710b8-e28b-4b23-bfaa-8e9692329e88@thread.tacv2",
3
    "set_sharepoint_site_to_read_only": true
4
}

Sample Output

1
{
2
    "success": true
3
}

Clone team
Copy

Clones a team and its corresponding group.

Sample Input

1
{
2
    "team_id": "19:1c5b01696d2e4a7f8b5c8b2c71d09999@thread.tacv2",
3
    "display_name": "Marketing Team - Clone",
4
    "mail_nickname": "marketing-clone",
5
    "parts_to_clone": [
6
        "apps",
7
        "tabs",
8
        "settings",
9
        "channels"
10
    ],
11
    "classification": "Confidential",
12
    "description": "Cloned team for Marketing department",
13
    "visibility": "Private"
14
}

Sample Output

1
{
2
    "success": true
3
}

Create adaptive card
Copy

Create an adaptive card in a channel.

Sample Input

1
{
2
    "conversation": {
3
        "group_id": "19:1c5b01696d2e4a7f8ba1a6bb0c71623b@thread.tacv2",
4
        "channel_id": "19:1c5b01696d2e4a7f8ba1a6bb0c71623b@thread.tacv2"
5
    },
6
    "card": {
7
        "type": "AdaptiveCard",
8
        "body": [
9
            {
10
                "type": "TextBlock",
11
                "size": "Medium",
12
                "weight": "Bolder",
13
                "text": "New Project Kickoff Meeting"
14
            },
15
            {
16
                "type": "TextBlock",
17
                "text": "Please confirm your attendance for the project kickoff meeting.",
18
                "wrap": true
19
            },
20
            {
21
                "type": "Input.Date",
22
                "id": "meetingDate",
23
                "label": "Meeting Date"
24
            }
25
        ],
26
        "actions": [
27
            {
28
                "type": "Action.Submit",
29
                "title": "Confirm Attendance",
30
                "data": {
31
                    "action": "confirm"
32
                }
33
            },
34
            {
35
                "type": "Action.Submit",
36
                "title": "Decline",
37
                "data": {
38
                    "action": "decline"
39
                }
40
            }
41
        ],
42
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
43
        "version": "1.2"
44
    },
45
    "mentions": [
46
        {
47
            "user": "29:1bSnHZ7eOILwsYYLU_DQUm0-1rnUNbsb9MNzuUGxQEQcufsITfcpDvIpxe-TsVZW0Y",
48
            "replace_text": "<at>John Doe</at>",
49
            "display_text": "John"
50
        }
51
    ],
52
    "workflow_urls": [
53
        "https://api.tray.io/workflows/12345/triggers/manual/runs"
54
    ],
55
    "response_message": "Thank you for your response!"
56
}

Sample Output

1
{
2
    "success": true,
3
    "activity_id": "1234567890.1234567890"
4
}

Create channel
Copy

Creates a new channel in a Microsoft Team.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "display_name": "Project X Discussion",
4
    "description": "Channel for discussing all aspects of Project X"
5
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#teams('12345678-1234-1234-1234-123456789012')/channels/$entity",
3
    "id": "19:abc123def456ghi789@thread.tacv2",
4
    "displayName": "Project X Discussion",
5
    "description": "Channel for discussing all aspects of Project X",
6
    "email": "projectx.discussion@example.com",
7
    "webUrl": "https://teams.microsoft.com/l/channel/19%3Aabc123def456ghi789%40thread.tacv2/Project%20X%20Discussion?groupId=12345678-1234-1234-1234-123456789012&tenantId=87654321-4321-4321-4321-210987654321"
8
}

Create chat message
Copy

Create a chat message in a channel.

Sample Input

1
{
2
    "group_id": "12345678-90ab-cdef-ghij-klmnopqrstuv",
3
    "channel_id": "19:abcdef0123456789@thread.tacv2",
4
    "subject": "Project Update",
5
    "content": "<p>Hello team! Here's an update on our project:</p><ul><li>Task A completed</li><li>Task B in progress</li><li>Task C starting next week</li></ul><p>Please review and let me know if you have any questions. @John Doe, can you provide an update on Task B?</p>",
6
    "content_type": "html",
7
    "mentions": {
8
        "channel": false,
9
        "group": false,
10
        "members": [
11
            "8765432a-bcde-fghi-jklm-nopqrstuvwxy"
12
        ]
13
    },
14
    "importance": "high"
15
}

Sample Output

1
{
2
    "id": "1234567890",
3
    "replyToId": null,
4
    "etag": "W/\"datetime'2023-05-15T14:30:00.1234567Z'\"",
5
    "messageType": "message",
6
    "createdDateTime": "2023-05-15T14:30:00.1234567Z",
7
    "lastModifiedDateTime": "2023-05-15T14:30:00.1234567Z",
8
    "deletedDateTime": null,
9
    "subject": "Project Update",
10
    "summary": null,
11
    "importance": "high",
12
    "locale": "en-US",
13
    "webUrl": "https://teams.microsoft.com/l/message/19:abcdef0123456789@thread.tacv2/1234567890?groupId=12345678-90ab-cdef-ghij-klmnopqrstuv&tenantId=98765432-10fe-dcba-9876-543210fedcba",
14
    "policyViolation": false,
15
    "from": {
16
        "user": {
17
            "id": "87654321-fedc-ba98-7654-321fedcba987",
18
            "displayName": "Jane Smith",
19
            "userIdentityType": "aadUser"
20
        }
21
    },
22
    "body": {
23
        "contentType": "html",
24
        "content": "<p>Hello team! Here's an update on our project:</p><ul><li>Task A completed</li><li>Task B in progress</li><li>Task C starting next week</li></ul><p>Please review and let me know if you have any questions. @John Doe, can you provide an update on Task B?</p>"
25
    },
26
    "attachments": [],
27
    "mentions": [
28
        {
29
            "id": 0,
30
            "mentionText": "John Doe",
31
            "mentioned": {
32
                "user": {
33
                    "id": "8765432a-bcde-fghi-jklm-nopqrstuvwxy",
34
                    "displayName": "John Doe",
35
                    "userIdentityType": "aadUser"
36
                }
37
            }
38
        }
39
    ],
40
    "reactions": [],
41
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('12345678-90ab-cdef-ghij-klmnopqrstuv')/channels('19:abcdef0123456789@thread.tacv2')/messages/$entity"
42
}

Create group
Copy

Creates an Office 365 group (unified), a dynamic group or security group.

Sample Input

1
{
2
    "display_name": "Marketing Team",
3
    "mail_nickname": "marketing-team",
4
    "security_enabled": false,
5
    "visibility": "Private",
6
    "group_type": "Unified",
7
    "owners": [
8
        "john.doe@example.com",
9
        "jane.smith@example.com"
10
    ],
11
    "members": [
12
        "alice.johnson@example.com",
13
        "bob.wilson@example.com",
14
        "carol.brown@example.com"
15
    ]
16
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
3
    "id": "1234abcd-5678-90ef-ghij-klmnopqrstuv",
4
    "createdDateTime": "2023-05-15T10:30:45Z",
5
    "displayName": "Marketing Team",
6
    "description": null,
7
    "groupTypes": [
8
        "Unified"
9
    ],
10
    "mail": "marketing-team@example.com",
11
    "mailEnabled": true,
12
    "mailNickname": "marketing-team",
13
    "securityEnabled": false,
14
    "visibility": "Private",
15
    "renewedDateTime": "2023-05-15T10:30:45Z",
16
    "resourceBehaviorOptions": [],
17
    "resourceProvisioningOptions": [
18
        "Team"
19
    ],
20
    "proxyAddresses": [
21
        "SMTP:marketing-team@example.com"
22
    ]
23
}

Delete channel
Copy

Deletes a channel.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "channel_id": "19:a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6@thread.tacv2"
4
}

Sample Output

1
{
2
    "success": true
3
}

Delete group
Copy

Deletes a specified group.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
3
}

Sample Output

1
{
2
    "success": true
3
}

Get channel
Copy

Returns information about a channel.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "channel_id": "19:a1b2c3d4e5f6g7h8@thread.tacv2"
4
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')/channels/$entity",
3
    "id": "19:a1b2c3d4e5f6g7h8@thread.tacv2",
4
    "displayName": "Marketing Campaign",
5
    "description": "Channel for discussing our upcoming marketing campaign",
6
    "email": "Marketing.Campaign@example.com",
7
    "webUrl": "https://teams.microsoft.com/l/channel/19:a1b2c3d4e5f6g7h8@thread.tacv2/Marketing%20Campaign?groupId=1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p&tenantId=1234abcd-5678-90ef-ghij-klmnopqrstuv"
8
}

Get channel tab
Copy

Returns information about a specific tab.

Sample Input

1
{
2
    "group_id": "1234567890abcdef",
3
    "channel_id": "19:abcdef1234567890@thread.tacv2",
4
    "tab_id": "01ABCDEF-2345-6789-0123-456789ABCDEF"
5
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1234567890abcdef')/channels('19:abcdef1234567890@thread.tacv2')/tabs/$entity",
3
    "id": "01ABCDEF-2345-6789-0123-456789ABCDEF",
4
    "displayName": "Project Planning",
5
    "webUrl": "https://teams.microsoft.com/l/tab/01ABCDEF-2345-6789-0123-456789ABCDEF?label=Project+Planning&tenantId=1234abcd-5678-90ef-ghij-klmnopqrstuv",
6
    "configuration": {
7
        "entityId": "projectPlanning123",
8
        "contentUrl": "https://app.contoso.com/projects/123",
9
        "removeUrl": "https://app.contoso.com/projects/123/remove",
10
        "websiteUrl": "https://app.contoso.com/projects/123",
11
        "wikiTabId": 12345,
12
        "wikiDefaultTab": false,
13
        "hasContent": true
14
    }
15
}

Get group
Copy

Returns information about a group.

Sample Input

1
{
2
    "group_id": "12345678-90ab-cdef-ghij-klmnopqrstuv"
3
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
3
    "id": "12345678-90ab-cdef-ghij-klmnopqrstuv",
4
    "deletedDateTime": null,
5
    "classification": "High",
6
    "createdDateTime": "2023-05-15T10:30:00Z",
7
    "creationOptions": [],
8
    "description": "Marketing team for product launches",
9
    "displayName": "Marketing Team",
10
    "expirationDateTime": null,
11
    "externalGroupIds": [],
12
    "externalGroupProviderId": null,
13
    "externalGroupState": null,
14
    "groupTypes": [
15
        "Unified"
16
    ],
17
    "isAssignableToRole": null,
18
    "mail": "marketing@contoso.com",
19
    "mailEnabled": true,
20
    "mailNickname": "marketing",
21
    "membershipRule": null,
22
    "membershipRuleProcessingState": null,
23
    "membershipTypes": [],
24
    "onPremisesLastSyncDateTime": null,
25
    "onPremisesSecurityIdentifier": null,
26
    "onPremisesSyncEnabled": null,
27
    "preferredDataLocation": null,
28
    "preferredLanguage": "en-US",
29
    "proxyAddresses": [
30
        "SMTP:marketing@contoso.com"
31
    ],
32
    "renewedDateTime": "2023-05-15T10:30:00Z",
33
    "resourceBehaviorOptions": [],
34
    "resourceProvisioningOptions": [],
35
    "securityEnabled": false,
36
    "securityIdentifier": "S-1-12-1-1234567890-123456789-1234567890-1234567",
37
    "theme": null,
38
    "visibility": "Private",
39
    "onPremisesProvisioningErrors": []
40
}

Get group notebook
Copy

Returns information about a notebook associated with a group.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "notebook_id": "0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p"
4
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')/onenote/notebooks/$entity",
3
    "id": "0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
4
    "self": "https://graph.microsoft.com/v1.0/groups/1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p/onenote/notebooks/0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
5
    "createdDateTime": "2023-05-15T10:30:00Z",
6
    "displayName": "Project X Notebook",
7
    "lastModifiedDateTime": "2023-05-20T14:45:00Z",
8
    "isDefault": false,
9
    "userRole": "Owner",
10
    "isShared": true,
11
    "sectionsUrl": "https://graph.microsoft.com/v1.0/groups/1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p/onenote/notebooks/0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p/sections",
12
    "sectionGroupsUrl": "https://graph.microsoft.com/v1.0/groups/1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p/onenote/notebooks/0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p/sectionGroups",
13
    "createdBy": {
14
        "user": {
15
            "id": "9876543210abcdef",
16
            "displayName": "John Doe"
17
        }
18
    },
19
    "lastModifiedBy": {
20
        "user": {
21
            "id": "fedcba0123456789",
22
            "displayName": "Jane Smith"
23
        }
24
    },
25
    "links": {
26
        "oneNoteClientUrl": {
27
            "href": "onenote:https://contoso.sharepoint.com/sites/ProjectX/SiteAssets/ProjectX%20Notebook"
28
        },
29
        "oneNoteWebUrl": {
30
            "href": "https://contoso.sharepoint.com/sites/ProjectX/_layouts/15/WopiFrame.aspx?sourcedoc={0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p}&action=edit"
31
        }
32
    }
33
}

Get group OneDrive item
Copy

Returns an item from the group's OneDrive.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "item_id": "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD4TL"
4
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#groups('12345678-1234-1234-1234-123456789012')/drive/items/$entity",
3
    "createdDateTime": "2023-05-15T10:30:45Z",
4
    "eTag": "\"aB35dF09cE8\"",
5
    "id": "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD4TL",
6
    "lastModifiedDateTime": "2023-05-16T14:22:18Z",
7
    "name": "Project Proposal.docx",
8
    "webUrl": "https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Project%20Proposal.docx",
9
    "cTag": "\"c:{B4115687-2C5F-4A3F-B4BD-1DC36F23BA3D},1\"",
10
    "size": 25678,
11
    "createdBy": {
12
        "user": {
13
            "email": "johndoe@contoso.com",
14
            "id": "87654321-4321-4321-4321-210987654321",
15
            "displayName": "John Doe"
16
        }
17
    },
18
    "lastModifiedBy": {
19
        "user": {
20
            "email": "janedoe@contoso.com",
21
            "id": "98765432-5432-5432-5432-321098765432",
22
            "displayName": "Jane Doe"
23
        }
24
    },
25
    "parentReference": {
26
        "driveId": "b!kIcyViBCLkaTsYJgp0iXsie_qxt-EeRJl-AGHv1mbhJhjeF3zYdEQJgSo1-5tP8I",
27
        "driveType": "documentLibrary",
28
        "id": "01BYE5RZ2FKXMKWDHENFFKH56SGCHTDG3N",
29
        "path": "/drive/root:/Marketing/Projects"
30
    },
31
    "fileSystemInfo": {
32
        "createdDateTime": "2023-05-15T10:30:45Z",
33
        "lastModifiedDateTime": "2023-05-16T14:22:18Z"
34
    },
35
    "folder": {
36
        "childCount": 0
37
    }
38
}

Get signed in user
Copy

Retrieve signed in user's details.

Sample Input

1
{}

Sample Output

1
{
2
    "businessPhones": [
3
        "+1 (555) 123-4567",
4
        "+1 (555) 987-6543"
5
    ],
6
    "displayName": "John Doe",
7
    "givenName": "John",
8
    "jobTitle": "Software Engineer",
9
    "mail": "john.doe@example.com",
10
    "mobilePhone": "+1 (555) 555-5555",
11
    "officeLocation": "Building A, Floor 3",
12
    "preferredLanguage": "en-US",
13
    "surname": "Doe",
14
    "userPrincipalName": "john.doe@example.com",
15
    "id": "12345678-90ab-cdef-1234-567890abcdef",
16
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity"
17
}

Get user
Copy

Returns information about a user.

Sample Input

1
{
2
    "user_id": "john.doe@example.com"
3
}

Sample Output

1
{
2
    "businessPhones": [
3
        "+1 (555) 123-4567",
4
        "+1 (555) 987-6543"
5
    ],
6
    "displayName": "John Doe",
7
    "givenName": "John",
8
    "jobTitle": "Software Engineer",
9
    "mail": "john.doe@example.com",
10
    "mobilePhone": "+1 (555) 555-5555",
11
    "officeLocation": "Building A, Floor 3",
12
    "preferredLanguage": "en-US",
13
    "surname": "Doe",
14
    "userPrincipalName": "john.doe@example.com",
15
    "id": "12345678-90ab-cdef-1234-567890abcdef",
16
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity"
17
}

List channel tabs
Copy

Returns a list of tabs in a channel.

Sample Input

1
{
2
    "group_id": "1234567890abcdef",
3
    "channel_id": "19:abcdef1234567890@thread.tacv2",
4
    "select": [
5
        "id",
6
        "displayName",
7
        "webUrl"
8
    ],
9
    "filter": [
10
        {
11
            "field_name": "displayName",
12
            "operator": "eq",
13
            "value": "Important Documents"
14
        }
15
    ],
16
    "condition": "and"
17
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1234567890abcdef')/channels('19:abcdef1234567890@thread.tacv2')/tabs(id,displayName,webUrl)",
3
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/teams/1234567890abcdef/channels/19:abcdef1234567890@thread.tacv2/tabs?$skiptoken=X'12345678'",
4
    "value": [
5
        {
6
            "id": "01234567-89ab-cdef-0123-456789abcdef",
7
            "displayName": "Important Documents",
8
            "webUrl": "https://teams.microsoft.com/l/tab/01234567-89ab-cdef-0123-456789abcdef?label=Important+Documents&tenantId=1234abcd-5678-90ef-ghij-klmnopqrstuv"
9
        }
10
    ]
11
}

List channels
Copy

Returns a list of channels for a specific group.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "select": [
4
        "id",
5
        "displayName",
6
        "description"
7
    ],
8
    "filter": [
9
        {
10
            "field_name": "displayName",
11
            "operator": "eq",
12
            "value": "General"
13
        }
14
    ],
15
    "condition": "and"
16
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#teams('12345678-1234-1234-1234-123456789012')/channels(id,displayName,description)",
3
    "value": [
4
        {
5
            "id": "19:abc123def456@thread.tacv2",
6
            "displayName": "General",
7
            "description": "This is the general channel for the team"
8
        }
9
    ]
10
}

List group members
Copy

Returns a list of members for a specific group.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "select": [
4
        "id",
5
        "displayName",
6
        "mail",
7
        "userPrincipalName"
8
    ],
9
    "per_page": 10
10
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#users(id,displayName,mail,userPrincipalName)",
3
    "@odata_nextLink": "https://graph.microsoft.com/v1.0/groups/12345678-1234-1234-1234-123456789012/members?$select=id,displayName,mail,userPrincipalName&$top=10&$skiptoken=X%274453707402900740299%27",
4
    "value": [
5
        {
6
            "id": "87654321-4321-4321-4321-210987654321",
7
            "displayName": "John Doe",
8
            "mail": "john.doe@example.com",
9
            "userPrincipalName": "john.doe@example.com"
10
        },
11
        {
12
            "id": "98765432-5432-5432-5432-321098765432",
13
            "displayName": "Jane Smith",
14
            "mail": "jane.smith@example.com",
15
            "userPrincipalName": "jane.smith@example.com"
16
        },
17
        {
18
            "id": "23456789-6543-6543-6543-432109876543",
19
            "displayName": "Bob Johnson",
20
            "mail": "bob.johnson@example.com",
21
            "userPrincipalName": "bob.johnson@example.com"
22
        }
23
    ]
24
}

List group notebooks
Copy

Returns a list of notebooks associated with a group.

Sample Input

1
{
2
    "group_id": "12345678-90ab-cdef-1234-567890abcdef",
3
    "select": [
4
        "id",
5
        "displayName",
6
        "lastModifiedDateTime"
7
    ],
8
    "filter": [
9
        {
10
            "field_name": "isDefault",
11
            "operator": "eq",
12
            "value": true
13
        }
14
    ],
15
    "condition": "and",
16
    "sort_by": "lastModifiedDateTime",
17
    "sort_order": "desc",
18
    "per_page": 25,
19
    "skip_token": "pqrstuvwxyz"
20
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups('12345678-90ab-cdef-1234-567890abcdef')/onenote/notebooks(id,displayName,lastModifiedDateTime)",
3
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/groups/12345678-90ab-cdef-1234-567890abcdef/onenote/notebooks?$select=id,displayName,lastModifiedDateTime&$filter=isDefault eq true&$orderby=lastModifiedDateTime desc&$top=25&$skiptoken=abcdefghijk",
4
    "value": [
5
        {
6
            "id": "11111111-2222-3333-4444-555555555555",
7
            "displayName": "Team Notebook",
8
            "lastModifiedDateTime": "2023-06-15T14:30:00Z"
9
        },
10
        {
11
            "id": "66666666-7777-8888-9999-000000000000",
12
            "displayName": "Project Planning",
13
            "lastModifiedDateTime": "2023-06-14T09:45:00Z"
14
        }
15
    ]
16
}

List group owners
Copy

Returns a list of owners of a specific group.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "select": [
4
        "displayName",
5
        "mail",
6
        "userPrincipalName"
7
    ],
8
    "per_page": 10,
9
    "skip_token": "next_page_token_123"
10
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#users(displayName,mail,userPrincipalName)",
3
    "@odata_nextLink": "https://graph.microsoft.com/v1.0/groups/12345678-1234-1234-1234-123456789012/owners?$select=displayName,mail,userPrincipalName&$skiptoken=next_page_token_456",
4
    "value": [
5
        {
6
            "@odata_type": "#microsoft.graph.user",
7
            "id": "87654321-4321-4321-4321-210987654321",
8
            "displayName": "John Doe",
9
            "mail": "john.doe@example.com",
10
            "userPrincipalName": "john.doe@example.com"
11
        },
12
        {
13
            "@odata_type": "#microsoft.graph.user",
14
            "id": "98765432-5432-5432-5432-321098765432",
15
            "displayName": "Jane Smith",
16
            "mail": "jane.smith@example.com",
17
            "userPrincipalName": "jane.smith@example.com"
18
        }
19
    ]
20
}

List group plans
Copy

Returns a list of plans associated with a group.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "per_page": 50,
4
    "skip_token": "pqrstuvwxyz"
5
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#planner/plans",
3
    "@odata_count": 2,
4
    "value": [
5
        {
6
            "@odata_etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"",
7
            "createdDateTime": "2023-05-15T09:30:00Z",
8
            "owner": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
9
            "title": "Q3 Marketing Campaign",
10
            "id": "abcdef12-3456-7890-abcd-ef1234567890",
11
            "createdBy": {
12
                "user": {
13
                    "displayName": "John Doe",
14
                    "id": "user123-4567-89ab-cdef-123456789012"
15
                }
16
            }
17
        },
18
        {
19
            "@odata_etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"",
20
            "createdDateTime": "2023-05-16T14:45:00Z",
21
            "owner": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
22
            "title": "Product Launch Project",
23
            "id": "fedcba98-7654-3210-fedc-ba9876543210",
24
            "createdBy": {
25
                "application": {
26
                    "displayName": "Planner App",
27
                    "id": "app987-6543-21fe-dcba-987654321098"
28
                }
29
            }
30
        }
31
    ]
32
}

List groups
Copy

Returns a list of groups (an AD group, Office 365 group, a team group, a dynamic group or a security group).

Sample Input

1
{
2
    "select": [
3
        "id",
4
        "displayName",
5
        "mail",
6
        "groupTypes"
7
    ],
8
    "filter": [
9
        {
10
            "field_name": "mailEnabled",
11
            "operator": "eq",
12
            "value": true
13
        }
14
    ],
15
    "condition": "and",
16
    "sort_by": "displayName",
17
    "sort_order": "asc",
18
    "per_page": 10
19
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(id,displayName,mail,groupTypes)",
3
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/groups?$select=id,displayName,mail,groupTypes&$filter=mailEnabled eq true&$orderby=displayName&$top=10&$skiptoken=X%274453707402000100000035536572766963652E437265617465644461746554696D65223A22323032332D30352D30385430393A32373A30302E3030303030303030305A22FEFF%27",
4
    "value": [
5
        {
6
            "id": "1234abcd-5678-90ef-ghij-klmnopqrstuv",
7
            "displayName": "Marketing Team",
8
            "mail": "marketing@contoso.com",
9
            "groupTypes": [
10
                "Unified"
11
            ]
12
        },
13
        {
14
            "id": "2345bcde-6789-01fg-hijk-lmnopqrstuvw",
15
            "displayName": "Sales Department",
16
            "mail": "sales@contoso.com",
17
            "groupTypes": [
18
                "Unified"
19
            ]
20
        },
21
        {
22
            "id": "3456cdef-7890-12gh-ijkl-mnopqrstuvwx",
23
            "displayName": "IT Support",
24
            "mail": "itsupport@contoso.com",
25
            "groupTypes": [
26
                "Unified"
27
            ]
28
        }
29
    ]
30
}

List organization users
Copy

Returns a list of users in the organizatiobn.

Sample Input

1
{
2
    "select": [
3
        "displayName",
4
        "mail",
5
        "jobTitle"
6
    ],
7
    "filter": [
8
        {
9
            "field_name": "jobTitle",
10
            "operator": "eq",
11
            "value": "Software Engineer"
12
        }
13
    ],
14
    "condition": "and",
15
    "sort_by": "displayName",
16
    "sort_order": "asc",
17
    "per_page": 10
18
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#users(displayName,mail,jobTitle)",
3
    "value": [
4
        {
5
            "displayName": "Alice Johnson",
6
            "mail": "alice.johnson@example.com",
7
            "jobTitle": "Software Engineer"
8
        },
9
        {
10
            "displayName": "Bob Smith",
11
            "mail": "bob.smith@example.com",
12
            "jobTitle": "Software Engineer"
13
        },
14
        {
15
            "displayName": "Charlie Brown",
16
            "mail": "charlie.brown@example.com",
17
            "jobTitle": "Software Engineer"
18
        }
19
    ]
20
}

List team apps
Copy

Returns a list of apps installed in the team.

Sample Input

1
{
2
    "team_id": "19:1c5b01696d2e4a179c292bc9cf04e047@thread.tacv2"
3
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('19:1c5b01696d2e4a179c292bc9cf04e047@thread.tacv2')/installedApps(teamsAppDefinition())",
3
    "value": [
4
        {
5
            "id": "NjkwM2ZhOTMtNjA1Yi00M2VmLTkyMWMtNjdjZGM3MDllZDU4IyMwMDAwMTAxNi1kZTA1LTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAjIyMw",
6
            "teamsAppDefinition": {
7
                "id": "MDEwNzJmOGEtODE5My00ZWY5LTk3NDctY2UwMzJlZjJmNGMw",
8
                "teamsAppId": "com.microsoft.teamspace.tab.planner",
9
                "displayName": "Tasks by Planner and To Do",
10
                "version": "2.0.3"
11
            }
12
        },
13
        {
14
            "id": "MTk6MWM1YjAxNjk2ZDJlNGExNzljMjkyYmM5Y2YwNGUwNDdAdGhyZWFkLnRhY3YyIyM3MzI0ODIwOS0wOTM5LTQ5MzItOTM2My1jNjAxMzNmYjM4MDc=",
15
            "teamsAppDefinition": {
16
                "id": "NzMyNDgyMDktMDkzOS00OTMyLTkzNjMtYzYwMTMzZmIzODA3",
17
                "teamsAppId": "com.microsoft.teamspace.tab.wiki",
18
                "displayName": "Wiki",
19
                "version": "1.1.0"
20
            }
21
        }
22
    ]
23
}

List user teams
Copy

Returns a list of teams that a specific user is a member of.

Sample Input

1
{
2
    "user_id": "john.doe@example.com"
3
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams",
3
    "value": [
4
        {
5
            "id": "19:2a84b1c1-5c8a-43ac-9d68-3d2574a1b6a7@thread.tacv2",
6
            "displayName": "Marketing Team",
7
            "description": "Team for marketing department collaboration",
8
            "isArchived": false
9
        },
10
        {
11
            "id": "19:3b7f8d5e-9c2a-4b1d-8f3e-1a5c2d9e8f7a@thread.tacv2",
12
            "displayName": "Project X",
13
            "description": "Team for Project X development",
14
            "isArchived": false
15
        },
16
        {
17
            "id": "19:4c9a1f2d-6b3e-5a7c-8d9f-2e1b3c4d5e6f@thread.tacv2",
18
            "displayName": "Company-wide Announcements",
19
            "description": "Official channel for company-wide communications",
20
            "isArchived": true
21
        }
22
    ]
23
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "POST",
3
    "url": {
4
        "endpoint": "/teams/123456/channels"
5
    },
6
    "headers": [
7
        {
8
            "key": "Content-Type",
9
            "value": "application/json"
10
        }
11
    ],
12
    "body": {
13
        "raw": {
14
            "displayName": "Marketing Projects",
15
            "description": "Channel for discussing marketing projects"
16
        }
17
    },
18
    "include_raw_body": true,
19
    "parse_response": "true"
20
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 201,
4
        "headers": {
5
            "Content-Type": "application/json",
6
            "Location": "https://graph.microsoft.com/v1.0/teams/123456/channels/789012"
7
        },
8
        "body": {
9
            "id": "789012",
10
            "displayName": "Marketing Projects",
11
            "description": "Channel for discussing marketing projects",
12
            "webUrl": "https://teams.microsoft.com/l/channel/789012/Marketing%20Projects",
13
            "createdDateTime": "2023-05-15T10:30:45Z"
14
        }
15
    }
16
}

Remove member from group
Copy

Removes a member from an Office 365 group (unified), a dynamic group or security group.

Sample Input

1
{
2
    "group_id": "4bcd6-7ef8-9012-3456-7890abcdef12",
3
    "member_id": "98765-4321-fedc-ba98-7654321fedcb"
4
}

Sample Output

1
{
2
    "success": true
3
}

Remove owner from group
Copy

Removes an owner from an Office 365 group (unified), a dynamic group or security group.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "owner_id": "9876fedc-ba98-7654-3210-fedcba987654"
4
}

Sample Output

1
{
2
    "success": true
3
}

Remove tab from channel
Copy

Removes a tab from a channel.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "channel_id": "19:a1b2c3d4e5f6g7h8@thread.tacv2",
4
    "tab_id": "01234567-89ab-cdef-0123-456789abcdef"
5
}

Sample Output

1
{
2
    "success": true
3
}

Search group OneDrive items
Copy

Returns a list of items in the group's OneDrive according to search criteria.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "search_text": "project proposal",
4
    "select": [
5
        "name",
6
        "webUrl",
7
        "size",
8
        "lastModifiedDateTime"
9
    ],
10
    "filter": [
11
        {
12
            "field_name": "size",
13
            "operator": "gt",
14
            "value": 1000000
15
        }
16
    ],
17
    "condition": "and"
18
}

Sample Output

1
{
2
    "@odata_context": "https://graph.microsoft.com/v1.0/$metadata#drives('12345678-1234-1234-1234-123456789012')/root/search(query='project proposal')",
3
    "value": [
4
        {
5
            "name": "Project Proposal 2023.docx",
6
            "webUrl": "https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Project%20Proposal%202023.docx",
7
            "size": 2500000,
8
            "lastModifiedDateTime": "2023-05-15T14:30:00Z"
9
        },
10
        {
11
            "name": "Project Proposal Presentation.pptx",
12
            "webUrl": "https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Project%20Proposal%20Presentation.pptx",
13
            "size": 3750000,
14
            "lastModifiedDateTime": "2023-05-16T09:45:00Z"
15
        }
16
    ]
17
}

Unarchive team
Copy

Unarchives a team (makes it writable).

Sample Input

1
{
2
    "team_id": "19:1c3b7d0b5c76458cbb5e4b21c0cde3f4@thread.tacv2"
3
}

Sample Output

1
{
2
    "success": true
3
}

Update adaptive card
Copy

Update an adaptive card in a channel.

Sample Input

1
{
2
    "id": "1234567890",
3
    "conversation": {
4
        "group_id": "19:group_id_123@thread.tacv2",
5
        "channel_id": "19:channel_id_456@thread.tacv2"
6
    },
7
    "card": {
8
        "type": "AdaptiveCard",
9
        "body": [
10
            {
11
                "type": "TextBlock",
12
                "size": "Medium",
13
                "weight": "Bolder",
14
                "text": "Updated Project Status"
15
            },
16
            {
17
                "type": "TextBlock",
18
                "text": "The project timeline has been updated. Please review the changes."
19
            },
20
            {
21
                "type": "FactSet",
22
                "facts": [
23
                    {
24
                        "title": "Project Name:",
25
                        "value": "Website Redesign"
26
                    },
27
                    {
28
                        "title": "New Deadline:",
29
                        "value": "August 31, 2023"
30
                    }
31
                ]
32
            }
33
        ],
34
        "actions": [
35
            {
36
                "type": "Action.Submit",
37
                "title": "Acknowledge",
38
                "data": {
39
                    "action": "acknowledge"
40
                }
41
            }
42
        ],
43
        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
44
        "version": "1.2"
45
    },
46
    "mentions": [
47
        {
48
            "user": "user123",
49
            "replace_text": "<at>John Doe</at>",
50
            "display_text": "John"
51
        }
52
    ],
53
    "workflow_urls": [
54
        "https://app.tray.io/workflows/12345/trigger"
55
    ],
56
    "response_message": "Thank you for acknowledging the update."
57
}

Sample Output

1
{
2
    "success": true,
3
    "activity_id": "1234567890:1234567890"
4
}

Update channel
Copy

Updates a channel.

Sample Input

1
{
2
    "group_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
3
    "channel_id": "19:a1b2c3d4e5f6g7h8@thread.tacv2",
4
    "display_name": "Project Alpha",
5
    "description": "Channel for discussing Project Alpha updates and tasks"
6
}

Sample Output

1
{
2
    "success": true
3
}

Update channel tab
Copy

Updates a tab inside a channel.

Sample Input

1
{
2
    "group_id": "1234567890abcdef",
3
    "channel_id": "19:abcdef1234567890@thread.tacv2",
4
    "tab_id": "01ABCDEF-2345-6789-0123-456789ABCDEF",
5
    "display_name": "Updated Project Tracker",
6
    "configuration": {
7
        "entity_id": "projectTracker123",
8
        "content_url": "https://example.com/project-tracker",
9
        "remove_url": "https://example.com/remove-tab",
10
        "website_url": "https://example.com/project-tracker-web"
11
    }
12
}

Sample Output

1
{
2
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1234567890abcdef')/channels('19:abcdef1234567890@thread.tacv2')/tabs/$entity",
3
    "id": "01ABCDEF-2345-6789-0123-456789ABCDEF",
4
    "displayName": "Updated Project Tracker",
5
    "webUrl": "https://teams.microsoft.com/l/tab/01ABCDEF-2345-6789-0123-456789ABCDEF?label=Updated%20Project%20Tracker&groupId=1234567890abcdef&tenantId=98765432-1098-7654-3210-987654321098",
6
    "configuration": {
7
        "entityId": "projectTracker123",
8
        "contentUrl": "https://example.com/project-tracker",
9
        "removeUrl": "https://example.com/remove-tab",
10
        "websiteUrl": "https://example.com/project-tracker-web"
11
    }
12
}

Update group
Copy

Updates an Office 365 group (unified), a dynamic group or security group.

Sample Input

1
{
2
    "group_id": "12345678-1234-1234-1234-123456789012",
3
    "description": "Marketing team collaboration group",
4
    "display_name": "Marketing Team",
5
    "mail_nickname": "marketing",
6
    "security_enabled": false,
7
    "visibility": "Private",
8
    "group_type": "Unified",
9
    "allow_external_senders": true,
10
    "auto_subscribe_new_members": true
11
}

Sample Output

1
{
2
    "success": true
3
}

Update team
Copy

Updates a team.

Sample Input

1
{
2
    "team_id": "19:1c5b01696d2e4a179c292bc9cf04e63b@thread.tacv2",
3
    "fun_settings": {
4
        "allow_giphy": true,
5
        "giphy_content_rating": "moderate",
6
        "allow_stickers_and_memes": true,
7
        "allow_custom_memes": false
8
    },
9
    "guest_settings": {
10
        "allow_create_update_channels": false,
11
        "allow_delete_channels": false
12
    },
13
    "member_settings": {
14
        "allow_create_update_channels": true,
15
        "allow_delete_channels": false,
16
        "allow_add_remove_apps": true,
17
        "allow_create_update_remove_tabs": true,
18
        "allow_create_update_remove_connectors": false
19
    },
20
    "messaging_settings": {
21
        "allow_user_edit_messages": true,
22
        "allow_user_delete_messages": true,
23
        "allow_owner_delete_messages": true,
24
        "allow_team_mentions": true,
25
        "allow_channel_mentions": true
26
    }
27
}

Sample Output

1
{
2
    "success": true
3
}

DDL operations
Copy

List channel tabs (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "tabs": [
3
        {
4
            "id": "tab123456",
5
            "displayName": "General",
6
            "webUrl": "https://teams.microsoft.com/l/channel/19%3abc123...tab/General?groupId=teamId123&tenantId=tenantId456",
7
            "configuration": {
8
                "entityId": null,
9
                "contentUrl": null,
10
                "removeUrl": null,
11
                "websiteUrl": null
12
            },
13
            "teamsApp": {
14
                "id": "com.microsoft.teamspace.tab.wiki",
15
                "displayName": "Wiki",
16
                "distributionMethod": "store"
17
            }
18
        },
19
        {
20
            "id": "tab789012",
21
            "displayName": "Files",
22
            "webUrl": "https://teams.microsoft.com/l/channel/19%3abc123...tab/Files?groupId=teamId123&tenantId=tenantId456",
23
            "configuration": {
24
                "entityId": null,
25
                "contentUrl": null,
26
                "removeUrl": null,
27
                "websiteUrl": null
28
            },
29
            "teamsApp": {
30
                "id": "com.microsoft.teamspace.tab.files.sharepoint",
31
                "displayName": "Files",
32
                "distributionMethod": "store"
33
            }
34
        }
35
    ]
36
}

List channels (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "channels": [
3
        {
4
            "id": "19:channel1@thread.tacv2",
5
            "displayName": "General",
6
            "description": "This is the general channel for the team",
7
            "membershipType": "standard",
8
            "email": "general@team.microsoft.com"
9
        },
10
        {
11
            "id": "19:channel2@thread.tacv2",
12
            "displayName": "Project Alpha",
13
            "description": "Channel for Project Alpha discussions",
14
            "membershipType": "private",
15
            "email": "projectalpha@team.microsoft.com"
16
        },
17
        {
18
            "id": "19:channel3@thread.tacv2",
19
            "displayName": "Marketing",
20
            "description": "Marketing team channel",
21
            "membershipType": "standard",
22
            "email": "marketing@team.microsoft.com"
23
        }
24
    ]
25
}

List group members (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "members": [
3
        {
4
            "id": "87654321-4321-4321-4321-210987654321",
5
            "displayName": "John Doe",
6
            "userPrincipalName": "johndoe@example.com",
7
            "jobTitle": "Software Engineer",
8
            "department": "Engineering",
9
            "mail": "johndoe@example.com",
10
            "officeLocation": "Building A, Floor 3"
11
        },
12
        {
13
            "id": "12345678-1234-1234-1234-123456789012",
14
            "displayName": "Jane Smith",
15
            "userPrincipalName": "janesmith@example.com",
16
            "jobTitle": "Product Manager",
17
            "department": "Product",
18
            "mail": "janesmith@example.com",
19
            "officeLocation": "Building B, Floor 2"
20
        },
21
        {
22
            "id": "98765432-5678-5678-5678-987654321098",
23
            "displayName": "Mike Johnson",
24
            "userPrincipalName": "mikejohnson@example.com",
25
            "jobTitle": "UX Designer",
26
            "department": "Design",
27
            "mail": "mikejohnson@example.com",
28
            "officeLocation": "Building A, Floor 4"
29
        }
30
    ]
31
}

List group owners (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "owners": [
3
        {
4
            "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
5
            "displayName": "John Doe",
6
            "userPrincipalName": "johndoe@example.com",
7
            "mail": "johndoe@example.com",
8
            "jobTitle": "Software Engineer",
9
            "department": "Engineering"
10
        },
11
        {
12
            "id": "5f8b1d8e-3c1f-4a7b-9f5d-8e7f6a9b0c1d",
13
            "displayName": "Jane Smith",
14
            "userPrincipalName": "janesmith@example.com",
15
            "mail": "janesmith@example.com",
16
            "jobTitle": "Project Manager",
17
            "department": "Project Management"
18
        }
19
    ]
20
}

List groups (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "1234567890abcdef",
4
        "displayName": "Marketing Team",
5
        "description": "Group for marketing department",
6
        "mail": "marketing@example.com",
7
        "mailNickname": "marketing",
8
        "visibility": "Private"
9
    },
10
    {
11
        "id": "0987654321fedcba",
12
        "displayName": "IT Support",
13
        "description": "Group for IT support staff",
14
        "mail": "itsupport@example.com",
15
        "mailNickname": "itsupport",
16
        "visibility": "Public"
17
    },
18
    {
19
        "id": "abcdef1234567890",
20
        "displayName": "Sales Team",
21
        "description": "Group for sales department",
22
        "mail": "sales@example.com",
23
        "mailNickname": "sales",
24
        "visibility": "Private"
25
    }
26
]

List organization users (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "users": [
3
        {
4
            "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
5
            "displayName": "John Doe",
6
            "userPrincipalName": "johndoe@example.com",
7
            "mail": "johndoe@example.com",
8
            "jobTitle": "Software Engineer",
9
            "department": "Engineering",
10
            "officeLocation": "New York",
11
            "businessPhones": [
12
                "+1 (555) 123-4567"
13
            ],
14
            "mobilePhone": "+1 (555) 987-6543"
15
        },
16
        {
17
            "id": "7a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
18
            "displayName": "Jane Smith",
19
            "userPrincipalName": "janesmith@example.com",
20
            "mail": "janesmith@example.com",
21
            "jobTitle": "Product Manager",
22
            "department": "Product",
23
            "officeLocation": "San Francisco",
24
            "businessPhones": [
25
                "+1 (555) 234-5678"
26
            ],
27
            "mobilePhone": "+1 (555) 876-5432"
28
        }
29
    ]
30
}

List user teams (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "teams": [
3
        {
4
            "id": "19:1c3710b8-e28d-4f4c-b01c-1f1f712f2c3a_83e28e4e-1a46-4c82-9f92-9cd8d4fbd34f@unq.gbl.spaces",
5
            "displayName": "Marketing Team",
6
            "description": "Team for marketing department collaboration",
7
            "visibility": "private",
8
            "isArchived": false,
9
            "membershipType": "standard"
10
        },
11
        {
12
            "id": "19:2a5c10b7-f28e-5f5d-c02d-2f2f823f3d4b_94f39f5f-2b57-5d93-af03-ade9e5gce45f@unq.gbl.spaces",
13
            "displayName": "Sales Team",
14
            "description": "Team for sales department collaboration",
15
            "visibility": "public",
16
            "isArchived": false,
17
            "membershipType": "standard"
18
        },
19
        {
20
            "id": "19:3b6d21c9-g39f-6g6e-d13e-3g3g934g4e5c_a5g4ag6g-3c68-6ea4-bg14-bfg10g6gdf56g@unq.gbl.spaces",
21
            "displayName": "IT Support",
22
            "description": "Team for IT support and helpdesk",
23
            "visibility": "private",
24
            "isArchived": false,
25
            "membershipType": "standard"
26
        }
27
    ]
28
}
Previous

Overview

Next

Operations