HTTP Request for SharePoint - Site structure

☝

TL;DR - The SharePoint API is not only great to update items or set permissions, you can also use it to either read or create site structure and copy lists from one to another site collection. I will add more once I use them actively.

General

Hub site and its children

//first get the hubsiteid
Method: GET
Uri: /_api/site?$select=IsHubSite,HubSiteId

Result: body('Send_an_HTTP_request_to_SharePoint_-_Hub_Site_Id')?['d']?['HubSiteId']

//use result in another http action, by default the api will return a paged array. Using the top parameters gives you all sites in a single array. The service limit for assigning children to a hub is 500.
_api/v2.1/sites?$filter=sharepointIds/hubSiteId eq 'HUBSITEID'&$top=500

Getting a site i

This return an id property that contains three parts separated by commas. The second value is the site id.

_api/v2.0/sites/tenant.sharepoint.com:/sites/Training:/

Site and list fields / columns

Site and list columns use identical request bodies. Therefore, they are mentioned here together. Make sure you use the correct URI for your use case.

Get columns

Something to look out for is the StaticName property. This shows the fields internal name.

//URI Site columns
_api/web/fields

//URI List columns
_api/web/lists(guid'LISTGUID')/fields

Result: Array
body('ACTIONNAME')?['d']?['results']

//also works with select and filter
_api/web/lists(guid'LISTGUID')/fields?$select=__metadata,Title,FieldTypeKind,Required,EnforceUniqueValues,StaticName,Hidden&$filter=Hidden eq false
_api/web/lists/getByTitle('My list')/fields?$select=id,Title

Result: body('ACTIONNAME')?['d']?['results']

Get columns by internal name or title

_api/web/fields/GetByInternalNameOrTitle

Headers: 
{
  "Accept": "application/json;odata=verbose",
  "Content-Type": "application/json;odata=verbose"
}

Result: Object
body('ACTIONNAME')?['d']

Create (site/list) fields

⚠️

Each field has its own type and therefore, unique properties. Make yourself familiar with their properties.

General info: https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.field?view=sharepoint-csom

‣

Field Type Kinds and their properties (As of April 2026)

Always use the corresponding metadata type for the field; e.g. Number = SP.FieldNumber, DateTime = SP.FieldDateTime

⚠️

Currently this method does not support creating a lookup field.

Method: POST
Uri: _api/web/fields
Uri: _api/web/lists('LIST GUID')/fields

Headers: 
{
"Accept": "application/json;odata=verbose",
"Content-Type": "application/json;odata=verbose"
}

Body:
{
"__metadata":
	{
	"type": "SP.FieldXyz"
	},
	"FieldTypeKind": 2,
	"Title":"DisplayName",
	"StaticName":"InternalName",
	"Required": true,
	"SchemaXml": "Xml",
	"ReadOnlyField":false
}

Modify (site/list) fields

StaticName and InternalName cannot be changed after a column was created. Only other properties like Required can be changed.

⚠️

Changing shared properties like Title or Required, you can use SP.Field for the metadata type. If you are changing field specific properties, use the corresponding SP.FieldType (See list above).

Method: POST
Uri: _api/web/fields/GetByInternalNameOrTitle('InternalNameOrTitleOfColumn')
Uri: _api/web/lists('LIST ID')/fields/GetByInternalNameOrTitle('InternalNameOrTitleOfColumn')

Alternatively, use column id: _api/web/lists('LIST ID')/fields/getbyid('field guid')

Headers:
{
  "Accept": "application/json;odata=verbose",
  "Content-Type": "application/json;odata=verbose",
  "If-Match": "*",
  "X-HTTP-Method": "MERGE"
}

Body:

{
"__metadata":
	{
	"type": "SP.FIELDTYPE"
	},
	"Title":"DisplayName",
	"Required": true,
}

Delete (site/list) fields

Sometimes the action will return an error saying that the field cannot be found, this is wrong. If you can see in the UI, its there. In that case you will need to use the field id instead of the title. To do that

Method: POST
Uri: _api/web/fields/GetByInternalNameOrTitle('InternalNameOrTitleOfColumn')
Uri: _api/web/lists('LIST ID')/fields/GetByInternalNameOrTitle('InternalNameOrTitleOfColumn')

Alternatively, use column id: _api/web/lists('LIST ID')/fields/getbyid('field guid')

Headers:
{
  "Accept": "application/json;odata=verbose",
  "Content-Type": "application/json;odata=verbose",
  "IF-MATCH": "*",
  "X-HTTP-Method": "DELETE"
}

Lists

Something to look out for is the BaseType, 0 = List, 1 = Library

Sadly, this endpoint does not directly support filtering. You could use something like “GetByTitle(’SitePages’)” instead.

Method: GET
//all lists
Uri: _api/web/lists

//specific list
_api/web/lists('LIST GUID')
Uri: 
Headers:
{
  "accept": "application/json;odata=verbose",
  "content-type ": "application/json;odata=verbose"
}

Result: body('ACTIONNAME')?['d']?['results']

‣

Output (redacted)

{
    "statusCode": 200,
    "headers": {...},
    "body": {
        "d": {
            "results": [
                {
                    "__metadata": {
                        "id": "",
                        "uri": "",
                        "etag": "\"5\"",
                        "type": "SP.List"
                    },
                    "FirstUniqueAncestorSecurableObject": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "RoleAssignments": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "Author": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "ContentTypes": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "CreatablesInfo": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "DefaultView": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "DescriptionResource": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "EventReceivers": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "Fields": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "Forms": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "InformationRightsManagementSettings": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "Items": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "ParentWeb": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "RootFolder": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "Subscriptions": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "TitleResource": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "UserCustomActions": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "VersionPolicies": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "Views": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "WorkflowAssociations": {
                        "__deferred": {
                            "uri": ""
                        }
                    },
                    "AllowContentTypes": true,
                    "BaseTemplate": 101,
                    "BaseType": 1,
                    "ContentTypesEnabled": false,
                    "CrawlNonDefaultViews": false,
                    "Created": "2025-04-30T08:04:52Z",
                    "CurrentChangeToken": {
                        "__metadata": {
                            "type": "SP.ChangeToken"
                        },
                        "StringValue": "1;3;0fe2bb5b-866c-492f-8776-4770e80b2eaf;638930229200470000;159318039"
                    },
                    "DefaultContentApprovalWorkflowId": "00000000-0000-0000-0000-000000000000",
                    "DefaultItemOpenUseListSetting": false,
                    "Description": "",
                    "Direction": "none",
                    "DisableCommenting": false,
                    "DisableGridEditing": false,
                    "DocumentTemplateUrl": "/sites/SITE/_catalogs/hubsite/Forms/template.dotx",
                    "DraftVersionVisibility": 0,
                    "EnableAttachments": false,
                    "EnableFolderCreation": true,
                    "EnableMinorVersions": false,
                    "EnableModeration": false,
                    "EnableRequestSignOff": true,
                    "EnableVersioning": false,
                    "EntityTypeName": "OData__x005f_catalogs_x002f_hubsite",
                    "ExemptFromBlockDownloadOfNonViewableFiles": false,
                    "FileSavePostProcessingEnabled": false,
                    "ForceCheckout": false,
                    "HasExternalDataSource": false,
                    "Hidden": true,
                    "Id": "0fe2bb5b-866c-492f-8776-4770e80b2eaf",
                    "ImagePath": {
                        "__metadata": {
                            "type": "SP.ResourcePath"
                        },
                        "DecodedUrl": "/_layouts/15/images/itdl.png?rev=47"
                    },
                    "ImageUrl": "/_layouts/15/images/itdl.png?rev=47",
                    "DefaultSensitivityLabelForLibrary": "",
                    "SensitivityLabelToEncryptOnDownloadForLibrary": null,
                    "IrmEnabled": false,
                    "IrmExpire": false,
                    "IrmReject": false,
                    "IsApplicationList": false,
                    "IsCatalog": true,
                    "IsPrivate": false,
                    "ItemCount": 2,
                    "LastItemDeletedDate": "2025-04-30T08:04:52Z",
                    "LastItemModifiedDate": "2025-09-09T12:39:13Z",
                    "LastItemUserModifiedDate": "2025-04-30T08:04:52Z",
                    "ListExperienceOptions": 0,
                    "ListItemEntityTypeFullName": "SP.Data.LibraryName",
                    "MajorVersionLimit": 0,
                    "MajorWithMinorVersionsLimit": 0,
                    "MultipleDataList": false,
                    "NoCrawl": false,
                    "ParentWebPath": {
                        "__metadata": {
                            "type": "SP.ResourcePath"
                        },
                        "DecodedUrl": "/sites/SITE"
                    },
                    "ParentWebUrl": "/sites/SITE",
                    "ParserDisabled": false,
                    "ServerTemplateCanCreateFolders": true,
                    "TemplateFeatureId": "00bfea71-e717-4e80-aa17-d0c71b360101",
                    "Title": "_catalogs/hubsite"
                }
            ]
        }
    }
}

Get the relative url of a list

Method: GET
Uri: _api/web/lists('LIST GUID')?$select=Id,Title,RootFolder/ServerRelativeUrl&$expand=RootFolder

Result: body('HTTP ACTION NAME')?['d/RootFolder/ServerRelativeUrl']

‣

Response sample

Create list or modify list settings

Source: https://learn.microsoft.com/en-us/previous-versions/office/sharepoint-visio/jj245826(v=office.15)

⚠️

BaseTemplate: 100 = List, 101 = Library. Adding these exact headers is very important!

//Create list
Method: POST
Uri: _api/web/lists
Headers: 
{
"Accept": "application/json;odata=verbose",
"Content-Type": "application/json;odata=verbose"
}
Body: 
{
  "__metadata": {
    "type": "SP.List"
  },
  "AllowContentTypes": true,
  "BaseTemplate": 100,
 "ContentTypesEnabled": true,
 "Description": "My list description",
 "Title": "Test"
}

//Modify list settings
Method: POST
Uri: _api/web/lists('LIST GUID')
Headers: 
{
"Accept": "application/json;odata=verbose",
"Content-Type": "application/json;odata=verbose",
"If-Match": "*",
"X-HTTP-Method": "MERGE"
}
Body: 
{
  "__metadata": {
    "type": "SP.List"
  },
  "AllowContentTypes": true,
  "BaseTemplate": 100,
 "ContentTypesEnabled": true,
 "Description": "My list description",
 "Title": "Test"
}

‣

Response body of create a list - redacted

{
        "d": {
            "__metadata": {
                "id": "https://example.sharepoint.com/sites/xxx/_api/Web/Lists(guid'fe05d2d4-4fb4-4490-b839')",
                "uri": "https://example.sharepoint.com/sites/xxx/_api/Web/Lists(guid'fe05d2d4-4fb4-4490-b839')",
                "etag": "\"2\"",
                "type": "SP.List"
            },
            "AllowContentTypes": true,
            "BaseTemplate": 100,
            "BaseType": 0,
            "ContentTypesEnabled": false,
            "CrawlNonDefaultViews": false,
            "Created": "2026-04-29T11:32:02Z",
            "DefaultContentApprovalWorkflowId": "00000000-0000-0000-0000-000000000000",
            "DefaultItemOpenUseListSetting": false,
            "Description": "Description goes here",
            "Direction": "none",
            "DisableCommenting": false,
            "DisableGridEditing": false,
            "DocumentTemplateUrl": null,
            "DraftVersionVisibility": 0,
            "EnableAttachments": true,
            "EnableFolderCreation": false,
            "EnableMinorVersions": false,
            "EnableModeration": false,
            "EnableRequestSignOff": true,
            "EnableVersioning": true,
            "EntityTypeName": "list1",
            "ExemptFromBlockDownloadOfNonViewableFiles": false,
            "FileSavePostProcessingEnabled": false,
            "ForceCheckout": false,
            "HasExternalDataSource": false,
            "Hidden": false,
            "Id": "fe05d2d4-4fb4-4490-b839",
            "ImagePath": {
                "__metadata": {
                    "type": "SP.ResourcePath"
                },
                "DecodedUrl": "/_layouts/15/images/itgen.png?rev=50"
            },
            "ImageUrl": "/_layouts/15/images/itgen.png?rev=50",
            "DefaultSensitivityLabelForLibrary": "",
            "SensitivityLabelToEncryptOnDownloadForLibrary": null,
            "IrmEnabled": false,
            "IrmExpire": false,
            "IrmReject": false,
            "IsApplicationList": false,
            "IsCatalog": false,
            "IsPrivate": false,
            "ItemCount": 0,
            "LastItemDeletedDate": "2026-04-29T11:32:02Z",
            "LastItemModifiedDate": "2026-04-29T11:32:03Z",
            "LastItemUserModifiedDate": "2026-04-29T11:32:02Z",
            "ListExperienceOptions": 0,
            "ListItemEntityTypeFullName": "SP.Data.list",
            "MajorVersionLimit": 50,
            "MajorWithMinorVersionsLimit": 0,
            "MultipleDataList": false,
            "NoCrawl": false,
            "ParentWebPath": {
                "__metadata": {
                    "type": "SP.ResourcePath"
                },
                "DecodedUrl": "/sites/xxx"
            },
            "ParentWebUrl": "/sites/xxx",
            "ParserDisabled": false,
            "ServerTemplateCanCreateFolders": true,
            "TemplateFeatureId": "00bfea71-de22-43b2-a848",
            "Title": "test"
        }

Deleting a list

Method: DELETE
Uri: _api/web/lists('LISTGUID')
Headers: 
{
"Accept": "application/json;odata=verbose",
"Content-Type": "application/json;odata=verbose"
}

Content types

Get all list content types

Supports: Select, Filter

Method: GET
Uri: _api/web/Lists('LISTGUID')/ContentTypes

Result: body('ACTIONNAME')?['d']?['results']

Create list content type

Method: POST
Uri: _api/web/Lists(guid'LISTGUID')/ContentTypes

Body:
{
  "__metadata": {
    "type": "SP.ContentType"
  },
  "Name": "New Content Type",
  "Description": "New Content Type Description",
  "Group": "Custom Content Type Group"
}

Modify existing list content type

Enable modern form for document sets

🚨

THIS IS NOT REVERSIBLE. As this a change on library level, the only way to undo this change is to delete the content type from the library and add it again. Make sure this is well thought out, best case would be to do this right at the beginning of whatever you are building.

Method: POST
Uri: _api/web/Lists('LISTGUID')/ContentTypes('CONTENTTYPEID')
Headers: 
{
  "Accept": "application/json;odata=verbose",
  "Content-Type": "application/json;odata=verbose",
  "If-Match": "*",
  "X-HTTP-Method": "MERGE"
}

Body:
{
  "__metadata": {
    "type": "SP.ContentType"
  },
  "Name":"New Name"
  "NewFormClientSideComponentId": ""
}

Content type fields

Get list content type fields

This would be part of a loop based on listing the content types.

Method: GET
Uri: _api/web/Lists('LIST GUID')/ContentTypes('item()?['StringId']}')/fields

Result: body('ACTIONNAME')?['d']?['results']

Remove list content type fields

Seems like its not possible now. I tried this:

Method: POST
Uri: _api/web/Lists('LIST GUID')/ContentTypes('item()?['StringId']}')/fields/getbyid('FIELD ID')

Headers:
{
  "Accept": "application/json;odata=verbose",
  "Content-Type": "application/json;odata=verbose",
  "IF-MATCH": "*",
  "X-HTTP-Method": "DELETE"
}

Views

Get list views

Method: GET
Uri: _api/web/lists(guid'LISTGUID')/Views
Result: body('ACTIONNAME')?['d']?['results']

//to get the default view and its id
Uri: _api/web/lists(guid'LISTGUID')/Views?$filter=DefaultView eq true
Result: first(body('ACTIONNAME')?['d']?['results'])?['Id']

‣

List view response (redacted and shortened)

List view fields

This would be a part of a loop based on listing the views.

Method: GET
Uri: _api/web/lists(guid'LISTGUID')/Views(guid'item()?['Id']')/ViewFields

Result: body('ACTIONNAME')?['d']?['results']

Changelog

Date	Changes
07.09.2025	Added remove field from list content type, not possible atm.
27.02.2026	Get the relative url of a list with example output
30.04.2026	Updated field and column section

Thanks for reading! 💕

Name	Comment	Value	Additional Properties	Link
Text		2	MaxLength: Integer	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldtext?view=sharepoint-csom
Note	Multiple lines of text	3	NumberOfLines: Integer, RichText: Boolean, AppendOnly: Boolean	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldmultilinetext?view=sharepoint-csom
DateTime	-	4	DateTimeFieldFormatType: 0 (DateOnly), 1 (DateTime) DateTimeFieldFriendlyFormatType: 1 (Disabled, Date (and Time)), 2 (Relative, xxx minutes ago)	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fielddatetime?view=sharepoint-csom
Single Choice	-	6	Choices: Array ({results: [”Choice 1”,”Choice 2”]}), FillInChoice (Boolean)	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldchoice?view=sharepoint-csom
Multi Choice	-	15	Choices: Array ({results: [”Choice 1”,”Choice 2”]}), FillInChoice (Boolean)	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldmultichoice?view=sharepoint-csom
Lookup	Currently not supported (April 2026)	7	AllowMultipleValues: Boolean	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldlookup?view=sharepoint-csom
Boolean	-	8	-	-
Number	Integer or Float	9	MaximumValue: Double, MinimumValue: Double	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldnumber?view=sharepoint-csom
Currency	-	10	-	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldcurrency?view=sharepoint-csom
URL	Used for: Hyperlink or Image	11	DisplayFormat: 0 (Hyperlink), 1 (Image)	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldurl?view=sharepoint-csom
Calculated	-	17	-	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fieldcalculated?view=sharepoint-csom
File	-	18	-	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.file?view=sharepoint-csom
User	-	20	Presence (Boolean), SelectionGroup: (Integer, SPO Group Id), SelectionMode: 0 (PeopleOnly), 1 (PeopleAndGroups)	https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.fielduser?view=sharepoint-csom