# Generate boarding link

GET https://api-sandbox.payabli.com/api/Templates/getlink/{templateId}/{ignoreEmpty}

Generates a boarding link from a boarding template.

Reference: https://docs.payabli.com/developers/api-reference/templates/generate-boarding-link-from-template

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Generate boarding link from template
  version: endpoint_templates.getlinkTemplate
paths:
  /Templates/getlink/{templateId}/{ignoreEmpty}:
    get:
      operationId: getlink-template
      summary: Generate boarding link from template
      description: Generates a boarding link from a boarding template.
      tags:
        - - subpackage_templates
      parameters:
        - name: templateId
          in: path
          description: >-
            The boarding template ID. Can be found at the end of the boarding
            template URL in PartnerHub. Example:
            `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`.
            Here, the template ID is `80`.
          required: true
          schema:
            type: number
            format: double
        - name: ignoreEmpty
          in: path
          description: >-
            Ignore read-only and empty fields Default is `false`. If
            `ignoreEmpty` = `false` and any field is empty, then the request
            returns a failure response. If `ignoreEmpty` = `true`, the request
            returns the boarding link name regardless of whether fields are
            empty.
          required: true
          schema:
            type: boolean
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:BoardingLinkApiResponse'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:ResponseText:
      type: string
    type_:BoardingLinkApiResponse:
      type: object
      properties:
        responseData:
          type: string
          description: |-
            Reference name for boarding link (if responseText = Success) or   
            List of empty fields separated by comma (if responseText = Fail)
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
      required:
        - responseText

```

## SDK Code Examples

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.templates.getlink_template(
    ignore_empty=True,
    template_id=80.0,
)

```

```typescript
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.templates.getlinkTemplate(80, true);

```

```go
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Templates.GetlinkTemplate(
	context.TODO(),
	true,
	80,
)

```

```csharp
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Templates.GetlinkTemplateAsync(true, 80);

```

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

url = URI("https://api-sandbox.payabli.com/api/Templates/getlink/80/true")

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

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

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

```java
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Templates/getlink/80/true")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Templates/getlink/80/true', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

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

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Templates/getlink/80/true")! 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()
```