Get Workspace information from the ProvisionPoint API

Title

URL Name

Get-Workspace-information-from-the-ProvisionPoint-API

Question

Answer

Use the GET method and the API to collect information about your requests, they will include everything that has been requested.

This article will guide you through how to make the API call and the filters that can be used to ensure you get the data you want.

This article presumes you have configured the API and know the endpoints needed, if not, read the ProvisionPoint API & Setup article.

If Directory Visibility has been restricted, this will also restrict the results from the API.
The requestor of API calls must also be granted additional visibility in all Service Definitions, in this case the security group linked to the app registration.

Get Individual workspace

Use a GET method in your calls to collect data from our app.
Ensure you have the base Url and endpoint (service-instances)
Collect the ServiceInstanceID - How to find the ServiceInstanceId for a Workspace
Add the ID to the end of the URL:
https://api.provisionpoint.com/v1.0/service-instances/12345
If you have an earlier Step in a flow or variable that defines this, replace with the variable instead of the number.

Output from API

When a request is made the following will be available from the API output.
Expand to see the output example

{
    "statusCode": 200,
    "headers": {
        "Date": "Thu, 16 Jul 2026 16:37:24 GMT",
        "Cache-Control": "no-store, no-cache",
        "Pragma": "no-cache",
        "Set-Cookie": "ARRAffinity=7af9f2cee10158bcdf7dc006ab0e6d8416004fb6e3a812ff85ad754fe92364;Path=/;HttpOnly;Secure;Domain=pp-api-prod-uk.azurewebsites.net,ARRAffinitySameSite=7af9f2cee10158bcdf7dc006ab0e6d8416004fb6e3a812ff85ad754fe92364;Path=/;HttpOnly;SameSite=None;Secure;Domain=pp-api-prod-uk.azurewebsites.net",
        "Vary": "Accept-Encoding",
        "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload",
        "Request-Context": "appId=cid-v1:8beb4285-89ff-40c3-9d0a-f20bffb537aa",
        "Content-Security-Policy": "upgrade-insecure-requests; frame-ancestors 'none'; script-src 'self'",
        "X-Frame-Options": "DENY",
        "X-XSS-Protection": "1; mode=block",
        "X-Content-Type-Options": "nosniff",
        "Referrer-Policy": "strict-origin-when-cross-origin",
        "Content-Type": "application/json; charset=utf-8",
        "Expires": "-1",
        "Content-Length": "2431"
    },
    "body": {
        "filterTotal": 1,
        "pageTotal": 1,
        "pageLimit": 20,
        "currentPageNumber": 1,
        "startNumber": 1,
        "endNumber": 1,
        "pageCount": 1,
        "currentPageParameters": "filterField1=name&filterValue1=Sales&filterOp1=contains&limit=20&page=1",
        "previousPageParameters": null,
        "nextPageParameters": null,
        "pageItems": [
            {
                "id": 263878,
                "name": "Sales",
                "description": null,
                "serviceType": 4,
                "instanceUrl": "https://teams.microsoft.com/l/team/19%3aB_dwQSL-A0sm6lcP1xS8aqSuctjmVoSWw-gRpPbtGuA1%40thread.tacv2/conversations?groupId=354c9328-3fa8-4d26-937a-dff8d68133ff&tenantId=be2606cf-9c7d-4c21-8d24-01e0e76dd8"",
                "serviceDefinitionName": "Department Team",
                "status": 5,
                "siteUrl": "https://mytenant.sharepoint.com/sites/ORG-Sales"",
                "groupId": "354c9328-3fa8-4d26-937a-dff8d68133ff",
                "teamInternalId": "19:B_dwQSL-A0sm6lcP1xS8aqSuctjmVoSWw-gRpPbtGuA1@thread.tacv2",
                "teamUrl": "https://teams.microsoft.com/l/team/19%3aB_dwQSL-A0sm6lcP1xS8aqSuctjmVoSWw-gRpPbtGuA1%40thread.tacv2/conversations?groupId=354c9328-3fa8-4d26-937a-dff8d68133ff&tenantId=be2606cf-9c7d-4c21-8d24-01e0e76dd8"",
                "plannerUrl": null,
                "yammerGroupId": null,
                "yammerUrl": null,
                "privacySetting": 1,
                "visibility": 0,
                "classification": null,
                "groupGuestAccess": 1,
                "externalSharing": 1,
                "storageQuota": null,
                "storageWarningLevel": null,
                "owners": [
                    {
                        "objectId": "d3be1e99-566c-4db1-b6bd-16a9763cd89f",
                        "principalType": 0,
                        "displayName": "Jenny Callow",
                        "pictureUrl": null,
                        "upn": "JennyC@mytenant.com",
                        "email": "jennyc@mytenant.com",
                        "jobTitle": null,
                        "preferredDataLocation": null,
                        "disabled": null,
                        "proxyAddresses": null,
                        "isDefaultOwner": false
                    }
                ],
                "formInstance": {
                    "name": "Department",
                    "fields": [
                        {
                            "name": "Department",
                            "columnId": 1407,
                            "columnTypeId": 3,
                            "dateTimeValueFormat": null,
                            "valueString": "Sales",
                            "valueBoolean": null,
                            "valueDateTime": null,
                            "valueInt": null,
                            "valuePrincipal": null,
                            "valueTerm": null
                        }
                    ]
                },
                "created": "2026-03-27T13:36:29+00:00",
                "instanceCreated": "2026-03-27T13:36:41+00:00",
                "leaseExpiryDate": null,
                "leaseStartDate": null,
                "isArchived": false,
                "isM365Archived": false,
                "isInstanceDeleted": false,
                "expiryProcessed": false,
                "geoCode": null,
                "sensitivityLabel": null,
                "requestedTitle": "anything",
                "requestedById": null,
                "requestedBy": {
                    "objectId": "d3be1e99-566c-4db1-b6bd-16a9763cd89f",
                    "principalType": 0,
                    "displayName": "Jenny Callow",
                    "pictureUrl": null,
                    "upn": "JennyC@mytenant.com",
                    "email": "jennyc@mytenant.com",
                    "jobTitle": null,
                    "preferredDataLocation": null,
                    "disabled": null,
                    "proxyAddresses": null,
                    "isDefaultOwner": false
                }
            }
        ]
    }
}

Get Multiple Workspaces

Use a GET method in your calls to collect data from our app.
Ensure you have the base Url and endpoint (service-instances)

The Url can include the following:

Page Limits
- The default will be 20 items from the first page
- Use ?limit=100 to increase to 100 items
- Use ?limit=100&page=2 to get page 2 and so on
- Alternatively, a Flow or script can be used to filter through all pages

Filters - Filters to the request can be applied to help locate multiple items. Expand to see the supported filters

Filter Property	Filter options
filterField	name - the name of the Group, Team, Site, Community or Planner servicedefinition.name - the name of the Service Definition template servicedefinitionid - the id for the Service Definition created - the creation date (ISO8601 format) url - the full url including https:// servicetype 1 = "Site Collection" 2 = "Sub Site" 3 = "Modern Team Site - M365 Group" 4 = "Microsoft Team" 5 = "Planner" 6 = "Viva Community" status 0 = Pending processing 1 = Paused 2 = Pending Approval 3 = In progress 4 = Failed 5 = Created 6 = Approval Rejected privacysettings - If the Group is Private or Public 0 = "None" 1 = "Private" 2 = "Public" groupguestaccess - if guest access is allowed or not (Group connected only) 0 = "None" 1 = "No Guests" 2 = "Guests Allowed" externalsharing - the external sharing level for the site 0 = "Organisation level default" 1 = "Only people in your org" 2 = "Existing Guests only" 3 = "New & existing guests" 4 = "Anyone" visibility - Directory visibility in ProvisionPoint only 0 = "Everyone" 1 = "Only Requestor group" 2 = "Owners only" sensitivitylabel - must be the id sensitivitylabelname - the name of the sensitivity label (container level only)
filterValue	enter the value to filter by
filterOp	eq = equals, the value must be a string contains, the value must be a string de = greater than, must be a date value le = less than, must be a date value

Examples: replace {API URL} with the correct base URL from the table of instances

Look for any workspaces with Project in the name:
- {BaseURL}/service-Instances?filterField1=name&filterValue1=Project&filterOp1=contains
Look for any workspaces that have been created successfully (Status 5):
- {BaseURL}/service-Instances?filterField1=status&filterValue1=5&filterOp1=eq
Look for any workspaces linked to the Viva Service Definition:
- {BaseURL}/service-Instances?filterField1=servicedefinition.name&filterValue1=Viva&filterOp1=eq
Look for any workspaces created after 18th September 2024:
- {BaseURL}/service-Instances?filterField1=created&filterValue1=2024-09-18T10:55:36.923Z&filterOp1=ge

Multiple filters can be applied by repeating the filter but with additional values, this will find all created items with Project in the name:
- {{BaseURL}/service-Instances?filterField1=status&filterValue1=5&filterOp1=eq&filterField2=name&filterValue2=Project&filterOp2=contains
  A maximum of 10 filters can be set.