# Get boarding link by reference

GET https://api-sandbox.payabli.com/api/Boarding/link/{boardingLinkReference}

Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.

Reference: https://docs.payabli.com/developers/api-reference/boarding/get-boarding-link-by-reference

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get boarding Link by reference
  version: endpoint_boarding.GetLinkApplication
paths:
  /Boarding/link/{boardingLinkReference}:
    get:
      operationId: get-link-application
      summary: Get boarding Link by reference
      description: >-
        Retrieves the details for a boarding link, by reference name. This
        endpoint requires an application API token.
      tags:
        - - subpackage_boarding
      parameters:
        - name: boardingLinkReference
          in: path
          description: >-
            The boarding link reference name. You can find this at the end of
            the boarding link URL. For example
            `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`
          required: true
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:BoardingLinkQueryRecord'
        '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_:AcceptOauth:
      type: boolean
    type_:AcceptRegister:
      type: boolean
    type_:ReadOnly:
      type: boolean
    type_:RequiredElement:
      type: boolean
    type_:ValueTemplates:
      type: string
    type_:LinkData:
      type: object
      properties:
        ro:
          $ref: '#/components/schemas/type_:ReadOnly'
        rq:
          $ref: '#/components/schemas/type_:RequiredElement'
        validator:
          type: string
          description: |-
            The type of validation applied to the field. Available values: 
            - text
            - alpha
            - ein
            - url
            - phone
            - alphanumeric
            - zipcode
            - numbers
            - float
            - ssn
            - email
            - routing
        value:
          $ref: '#/components/schemas/type_:ValueTemplates'
    type_:AchLinkTypes:
      type: object
      properties:
        ccd:
          $ref: '#/components/schemas/type_:LinkData'
        ppd:
          $ref: '#/components/schemas/type_:LinkData'
        web:
          $ref: '#/components/schemas/type_:LinkData'
    type_:LinkRow:
      type: object
      properties:
        columns:
          type: array
          items:
            $ref: '#/components/schemas/type_:LinkData'
    type_:BasicTable:
      type: object
      properties:
        body:
          type: array
          items:
            $ref: '#/components/schemas/type_:LinkRow'
        header:
          $ref: '#/components/schemas/type_:LinkRow'
    type_:AchSection:
      type: object
      properties:
        acceptance:
          $ref: '#/components/schemas/type_:AchLinkTypes'
        fees:
          $ref: '#/components/schemas/type_:BasicTable'
        price:
          $ref: '#/components/schemas/type_:BasicTable'
    type_:CardLinkTypes:
      type: object
      properties:
        amex:
          $ref: '#/components/schemas/type_:LinkData'
        discover:
          $ref: '#/components/schemas/type_:LinkData'
        mastercard:
          $ref: '#/components/schemas/type_:LinkData'
        visa:
          $ref: '#/components/schemas/type_:LinkData'
    type_:CardSection:
      type: object
      properties:
        acceptance:
          $ref: '#/components/schemas/type_:CardLinkTypes'
        fees:
          $ref: '#/components/schemas/type_:BasicTable'
        price:
          $ref: '#/components/schemas/type_:BasicTable'
    type_:SSection:
      type: object
      properties:
        ach:
          $ref: '#/components/schemas/type_:AchSection'
        card:
          $ref: '#/components/schemas/type_:CardSection'
    type_:ASection:
      type: object
      properties:
        minimumDocuments:
          type: integer
        multipleContacts:
          type: boolean
        multipleOwners:
          type: boolean
    type_:Bnk:
      type: object
      properties:
        accountNumber:
          $ref: '#/components/schemas/type_:LinkData'
        bankName:
          $ref: '#/components/schemas/type_:LinkData'
        routingAccount:
          $ref: '#/components/schemas/type_:LinkData'
        typeAccount:
          $ref: '#/components/schemas/type_:LinkData'
    type_:DSection:
      type: object
      properties:
        depositAccount:
          $ref: '#/components/schemas/type_:Bnk'
        withdrawalAccount:
          $ref: '#/components/schemas/type_:Bnk'
    type_:BAddress:
      type: object
      properties:
        baddress:
          $ref: '#/components/schemas/type_:LinkData'
        baddress1:
          $ref: '#/components/schemas/type_:LinkData'
        bcity:
          $ref: '#/components/schemas/type_:LinkData'
        bcountry:
          $ref: '#/components/schemas/type_:LinkData'
        bstate:
          $ref: '#/components/schemas/type_:LinkData'
        bzip:
          $ref: '#/components/schemas/type_:LinkData'
        maddress:
          $ref: '#/components/schemas/type_:LinkData'
        maddress1:
          $ref: '#/components/schemas/type_:LinkData'
        mcity:
          $ref: '#/components/schemas/type_:LinkData'
        mcountry:
          $ref: '#/components/schemas/type_:LinkData'
        mstate:
          $ref: '#/components/schemas/type_:LinkData'
        mzip:
          $ref: '#/components/schemas/type_:LinkData'
    type_:BDetails:
      type: object
      properties:
        btype:
          $ref: '#/components/schemas/type_:LinkData'
        dbaname:
          $ref: '#/components/schemas/type_:LinkData'
        ein:
          $ref: '#/components/schemas/type_:LinkData'
        faxnumber:
          $ref: '#/components/schemas/type_:LinkData'
        legalname:
          $ref: '#/components/schemas/type_:LinkData'
        license:
          $ref: '#/components/schemas/type_:LinkData'
        licstate:
          $ref: '#/components/schemas/type_:LinkData'
        phonenumber:
          $ref: '#/components/schemas/type_:LinkData'
        startdate:
          $ref: '#/components/schemas/type_:LinkData'
        taxfillname:
          $ref: '#/components/schemas/type_:LinkData'
        website:
          $ref: '#/components/schemas/type_:LinkData'
    type_:BSection:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/type_:BAddress'
        details:
          $ref: '#/components/schemas/type_:BDetails'
    type_:CList:
      type: object
      properties:
        contactEmail:
          $ref: '#/components/schemas/type_:LinkData'
        contactName:
          $ref: '#/components/schemas/type_:LinkData'
        contactPhone:
          $ref: '#/components/schemas/type_:LinkData'
        contactTitle:
          $ref: '#/components/schemas/type_:LinkData'
    type_:OList:
      type: object
      properties:
        oaddress:
          $ref: '#/components/schemas/type_:LinkData'
        ocity:
          $ref: '#/components/schemas/type_:LinkData'
        ocountry:
          $ref: '#/components/schemas/type_:LinkData'
        odriverstate:
          $ref: '#/components/schemas/type_:LinkData'
        ostate:
          $ref: '#/components/schemas/type_:LinkData'
        ownerdob:
          $ref: '#/components/schemas/type_:LinkData'
        ownerdriver:
          $ref: '#/components/schemas/type_:LinkData'
        owneremail:
          $ref: '#/components/schemas/type_:LinkData'
        ownername:
          $ref: '#/components/schemas/type_:LinkData'
        ownerpercent:
          $ref: '#/components/schemas/type_:LinkData'
        ownerphone1:
          $ref: '#/components/schemas/type_:LinkData'
        ownerphone2:
          $ref: '#/components/schemas/type_:LinkData'
        ownerssn:
          $ref: '#/components/schemas/type_:LinkData'
        ownertitle:
          $ref: '#/components/schemas/type_:LinkData'
        ozip:
          $ref: '#/components/schemas/type_:LinkData'
    type_:OSection:
      type: object
      properties:
        contact_list:
          $ref: '#/components/schemas/type_:CList'
        own_list:
          $ref: '#/components/schemas/type_:OList'
    type_:PSection:
      type: object
      properties:
        avgmonthly:
          $ref: '#/components/schemas/type_:LinkData'
        binperson:
          $ref: '#/components/schemas/type_:LinkData'
        binphone:
          $ref: '#/components/schemas/type_:LinkData'
        binweb:
          $ref: '#/components/schemas/type_:LinkData'
        bsummary:
          $ref: '#/components/schemas/type_:LinkData'
        highticketamt:
          $ref: '#/components/schemas/type_:LinkData'
        mcc:
          $ref: '#/components/schemas/type_:LinkData'
        ticketamt:
          $ref: '#/components/schemas/type_:LinkData'
        whenCharged:
          $ref: '#/components/schemas/type_:LinkData'
        whenDelivered:
          $ref: '#/components/schemas/type_:LinkData'
        whenProvided:
          $ref: '#/components/schemas/type_:LinkData'
        whenRefunded:
          $ref: '#/components/schemas/type_:LinkData'
    type_:BuilderData:
      type: object
      properties:
        services:
          $ref: '#/components/schemas/type_:SSection'
        attributes:
          $ref: '#/components/schemas/type_:ASection'
        banking:
          $ref: '#/components/schemas/type_:DSection'
        business:
          $ref: '#/components/schemas/type_:BSection'
        owners:
          $ref: '#/components/schemas/type_:OSection'
        processing:
          $ref: '#/components/schemas/type_:PSection'
    type_:EntryAttributes:
      type: string
    type_:FileContentFtype:
      type: string
      enum:
        - value: pdf
        - value: doc
        - value: docx
        - value: jpg
        - value: jpeg
        - value: png
        - value: gif
        - value: txt
    type_:FileContent:
      type: object
      properties:
        fContent:
          type: string
          description: >-
            Content of file, Base64-encoded. Ignored if furl is specified. Max
            upload size is 30 MB.
        filename:
          type: string
          description: The name of the attached file.
        ftype:
          $ref: '#/components/schemas/type_:FileContentFtype'
          description: The MIME type of the file (if content is provided)
        furl:
          type: string
          description: Optional URL provided to show or download the file remotely
    type_:Orgid:
      type: integer
      format: int64
    type_:PageIdentifier:
      type: string
    type_:RecipientEmailNotification:
      type: boolean
    type_:ReferenceName:
      type: string
    type_:ReferenceTemplateId:
      type: integer
      format: int64
    type_:Resumable:
      type: boolean
    type_:BoardingLinkQueryRecord:
      type: object
      properties:
        acceptOauth:
          $ref: '#/components/schemas/type_:AcceptOauth'
        acceptRegister:
          $ref: '#/components/schemas/type_:AcceptRegister'
        builderData:
          $ref: '#/components/schemas/type_:BuilderData'
        entryAttributes:
          $ref: '#/components/schemas/type_:EntryAttributes'
        id:
          type: integer
          format: int64
        logo:
          $ref: '#/components/schemas/type_:FileContent'
          description: Object containing logo file.
        orgId:
          $ref: '#/components/schemas/type_:Orgid'
        'pageIdentifier:':
          $ref: '#/components/schemas/type_:PageIdentifier'
        recipientEmailNotification:
          $ref: '#/components/schemas/type_:RecipientEmailNotification'
        referenceName:
          $ref: '#/components/schemas/type_:ReferenceName'
        referenceTemplateId:
          $ref: '#/components/schemas/type_:ReferenceTemplateId'
        resumable:
          $ref: '#/components/schemas/type_:Resumable'

```

## SDK Code Examples

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.boarding.get_link_application(
    boarding_link_reference="myorgaccountname-00091",
)

```

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

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.boarding.getLinkApplication("myorgaccountname-00091");

```

```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.Boarding.GetLinkApplication(
	context.TODO(),
	"myorgaccountname-00091",
)

```

```csharp
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Boarding.GetLinkApplicationAsync("myorgaccountname-00091");

```

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

url = URI("https://api-sandbox.payabli.com/api/Boarding/link/myorgaccountname-00091")

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/Boarding/link/myorgaccountname-00091")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Boarding/link/myorgaccountname-00091', [
  '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/Boarding/link/myorgaccountname-00091")! 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()
```