> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.tangerine365.com/llms.txt.
> For full documentation content, see https://docs.tangerine365.com/llms-full.txt.

# Webpages

GET https://localhost:8090//api/webpages/index
Content-Type: application/x-www-form-urlencoded

The `POST /api/webpages/index` endpoint is used to retrieve webpages from the system.

### Request

- Method: POST
    
- Base URL: {{baseUrl}}
    
- Path: /api/webpages/index
    
- Headers:
    
    - Content-Type: application/x-www-form-urlencoded
        

### Request Body

The request body for this endpoint is of type x-www-form-urlencoded.

- `auth` (string): Authentication token.
    

### Response

The response will be in JSON format and will include the following fields:

- `success` (string): Indicates the success status of the request.
    
- `message` (string): Provides additional information about the request.
    
- `data` (array): Contains an array of objects, each representing a webpage.
    
    - `id` (string): The unique identifier for the webpage.
        
    - `title` (string): The title of the webpage.
        
    - `description` (string): The description of the webpage and its content.

Reference: https://docs.tangerine365.com/tangerine-365-enterprise/webpages

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Tangerine365 Enterprise
  version: 1.0.0
paths:
  //api/webpages/index:
    get:
      operationId: webpages
      summary: Webpages
      description: >-
        The `POST /api/webpages/index` endpoint is used to retrieve webpages
        from the system.


        ### Request


        - Method: POST
            
        - Base URL: {{baseUrl}}
            
        - Path: /api/webpages/index
            
        - Headers:
            
            - Content-Type: application/x-www-form-urlencoded
                

        ### Request Body


        The request body for this endpoint is of type x-www-form-urlencoded.


        - `auth` (string): Authentication token.
            

        ### Response


        The response will be in JSON format and will include the following
        fields:


        - `success` (string): Indicates the success status of the request.
            
        - `message` (string): Provides additional information about the request.
            
        - `data` (array): Contains an array of objects, each representing a
        webpage.
            
            - `id` (string): The unique identifier for the webpage.
                
            - `title` (string): The title of the webpage.
                
            - `description` (string): The description of the webpage and its content.
      tags:
        - ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webpages_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
servers:
  - url: https://localhost:8090
components:
  schemas:
    ApiWebpagesIndexGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        description:
          type: string
      required:
        - id
        - title
        - description
      title: ApiWebpagesIndexGetResponsesContentApplicationJsonSchemaDataItems
    Webpages_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiWebpagesIndexGetResponsesContentApplicationJsonSchemaDataItems
        message:
          type: string
        success:
          type: string
      required:
        - data
        - message
        - success
      title: Webpages_Response_200

```

## SDK Code Examples

```python Webpages_example
import requests

url = "https://localhost:8090//api/webpages/index"

payload = ""
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.get(url, data=payload, headers=headers)

print(response.json())
```

```javascript Webpages_example
const url = 'https://localhost:8090//api/webpages/index';
const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams('')
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Webpages_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://localhost:8090//api/webpages/index"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Webpages_example
require 'uri'
require 'net/http'

url = URI("https://localhost:8090//api/webpages/index")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body
```

```java Webpages_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://localhost:8090//api/webpages/index")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .asString();
```

```php Webpages_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://localhost:8090//api/webpages/index', [
  'form_params' => null,
  'headers' => [
    'Content-Type' => 'application/x-www-form-urlencoded',
  ],
]);

echo $response->getBody();
```

```csharp Webpages_example
using RestSharp;

var client = new RestClient("https://localhost:8090//api/webpages/index");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
IRestResponse response = client.Execute(request);
```

```swift Webpages_example
import Foundation

let headers = ["Content-Type": "application/x-www-form-urlencoded"]

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8090//api/webpages/index")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```