# List all application links

GET https://api-sandbox.payabli.com/api/Query/boardinglinks/{orgId}

Return a list of boarding links for an organization. Use filters to limit results.

Reference: https://docs.payabli.com/developers/api-reference/boarding/get-list-of-boarding-links-for-organization

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get list of boarding links for organization
  version: endpoint_boarding.ListBoardingLinks
paths:
  /Query/boardinglinks/{orgId}:
    get:
      operationId: list-boarding-links
      summary: Get list of boarding links for organization
      description: >-
        Return a list of boarding links for an organization. Use filters to
        limit results.
      tags:
        - - subpackage_boarding
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
        - name: fromRecord
          in: query
          description: >-
            The number of records to skip before starting to collect the result
            set.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: >-
            Max number of records to return for the query. Use `0` or negative
            value to return all records.
          required: false
          schema:
            type: integer
            default: 20
        - name: parameters
          in: query
          description: >-
            Collection of field names, conditions, and values used to filter the
            query 


            See [Filters and Conditions
            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
            for help.


            List of field names accepted:

            - `lastUpdated` (gt, ge, lt, le, eq, ne)

            - `templateName` (ct, nct)

            - `referenceName` (ct, nct)

            - `acceptRegister` (eq, ne)

            - `acceptAuth` (eq, ne)

            - `templateCode` (ct, nct)

            - `templateId` (eq, ne)

            - `orgParentname` (ct, nct)


            List of comparison accepted - enclosed between parentheses:

            - eq or empty => equal

            - gt => greater than

            - ge => greater or equal

            - lt => less than 

            - le => less or equal

            - ne => not equal

            - ct => contains

            - nct => not contains

            - in => inside array

            - nin => not inside array


            List of parameters accepted:

            - limitRecord : max number of records for query (default="20", "0"
            or negative value for all)

            - fromRecord : initial record in query


            Example: templateName(ct)=hoa return all records with template title
            containing "hoa"
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
        - name: sortBy
          in: query
          description: >-
            The field name to use for sorting results. Use `desc(field_name)` to
            sort descending by `field_name`, and use `asc(field_name)` to sort
            ascending by `field_name`.
          required: false
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:QueryBoardingLinksResponse'
        '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_:EntryAttributes:
      type: string
    type_:LastModified:
      type: string
      format: date-time
    type_:OrgParentName:
      type: string
    type_:ReferenceName:
      type: string
    type_:ReferenceTemplateId:
      type: integer
      format: int64
    type_:TemplateCode:
      type: string
    type_:TemplateName:
      type: string
    type_:QueryBoardingLinksResponseRecordsItem:
      type: object
      properties:
        AcceptOauth:
          $ref: '#/components/schemas/type_:AcceptOauth'
        AcceptRegister:
          $ref: '#/components/schemas/type_:AcceptRegister'
        EntryAttributes:
          $ref: '#/components/schemas/type_:EntryAttributes'
        Id:
          type: integer
          description: The record ID.
        LastUpdated:
          $ref: '#/components/schemas/type_:LastModified'
        OrgParentName:
          $ref: '#/components/schemas/type_:OrgParentName'
        ReferenceName:
          $ref: '#/components/schemas/type_:ReferenceName'
        ReferenceTemplateId:
          $ref: '#/components/schemas/type_:ReferenceTemplateId'
        TemplateCode:
          $ref: '#/components/schemas/type_:TemplateCode'
        TemplateName:
          $ref: '#/components/schemas/type_:TemplateName'
    type_:PageIdentifier:
      type: string
    type_:Pagesize:
      type: integer
    type_:Totalrecords:
      type: integer
    type_:QuerySummary:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/type_:Pagesize'
        totalAmount:
          type: number
          format: double
          description: Total amount for the records.
        totalNetAmount:
          type: number
          format: double
          description: Total net amount for the records.
        totalPages:
          $ref: '#/components/schemas/type_:Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/type_:Totalrecords'
    type_:QueryBoardingLinksResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/type_:QueryBoardingLinksResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/type_:QuerySummary'

```

## SDK Code Examples

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.boarding.list_boarding_links(
    org_id=123,
    from_record=251,
    limit_record=0,
    sort_by="desc(field_name)",
)

```

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

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.boarding.listBoardingLinks(123, {
    fromRecord: 251,
    limitRecord: 0,
    sortBy: "desc(field_name)"
});

```

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

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Boarding.ListBoardingLinks(
	context.TODO(),
	123,
	&sdkgo.ListBoardingLinksRequest{
		FromRecord: sdkgo.Int(
			251,
		),
		LimitRecord: sdkgo.Int(
			0,
		),
		SortBy: sdkgo.String(
			"desc(field_name)",
		),
	},
)

```

```csharp
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Boarding.ListBoardingLinksAsync(
    123,
    new ListBoardingLinksRequest
    {
        FromRecord = 251,
        LimitRecord = 0,
        SortBy = "desc(field_name)",
    }
);

```

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

url = URI("https://api-sandbox.payabli.com/api/Query/boardinglinks/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")

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/Query/boardinglinks/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Query/boardinglinks/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [
  '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/Query/boardinglinks/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! 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()
```