Get Form
Retrieves the Nintex Form definition of the saved Nintex form for the specified SharePoint list and content type.
Note: This endpoint requires an access token from a Microsoft Entra ID app. See Authenticate with Microsoft Entra ID apps.
Request
| Method | Request URI | HTTP Version |
|---|---|---|
| GET | {baseURL}/api/v2/forms/{listId},{contentTypeId} | HTTP/1.1 |
Request Parameters
| Request Parameter | Description |
|---|---|
|
listId |
Required. The name or identifier of the SharePoint list or document library. |
|
contentTypeId |
Optional. The name or identifier of the SharePoint content type. If a value is not specified, the first content type defined for the list specified in listId is used. |
Request Headers
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
|
Content-Type |
Optional. application/json |
|
Authorization |
Required. JWT access token from the Entra ID app as a Bearer token: Bearer <token>. |
|
Site |
Required. SharePoint site URL. For example, https://acmecorp.sharepoint.com/sites/TestSite |
Request Body
None.
Response
The response includes an HTTP status code, response headers, and a response body.
Response Codes
| Code | Description |
|---|---|
| 200 | The specified form definition in JSON format was retrieved. |
| 400 | An invalid operation has occurred. |
| 401 | An invalid request body was specified. |
| 404 | The specified form could not be found. |
| 500 | Internal error. |
Response Headers
The following table describes response headers returned by a successful response. Other header values may also be returned, depending on SharePoint and ASP.NET configurations.
| Request Header | Description |
|---|---|
|
Content-Type |
application/json; charset=utf-8 |
|
Content-Length |
The length, in characters, of the response body. |
Response Body
If the method was successful, the Nintex Form definition in JSON format is returned.
| Content type | Description |
|---|---|
|
application/json |
A Nintex Form definition in JSON format. |
Otherwise, depending on the error, the method returns additional information about the error. For example, if the value of the listId property in the request body is set to a name or identifier that cannot be found on the SharePoint site, the response returns an HTTP 400 status code and a Request Error web page in which the error indicates that a list with the specified name does not exist.
Remarks
This method requires authentication via an Entra ID app, and does not support a SharePoint digest value. See Authenticate with Microsoft Entra ID apps.