# List API Apps

GET https://api.hellosign.com/v3/api_app/list

Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.

Reference: https://developer.hellosign.com/api/api-app/list

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: List API Apps
  version: endpoint_apiApp.list
paths:
  /api_app/list:
    get:
      operationId: list
      summary: List API Apps
      description: >-
        Returns a list of API Apps that are accessible by you. If you are on a
        team with an Admin or Developer role, this list will include apps owned
        by teammates.
      tags:
        - - subpackage_apiApp
      parameters:
        - name: page
          in: query
          description: Which page number of the API App List to return. Defaults to `1`.
          required: false
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          description: >-
            Number of objects to be returned per page. Must be between `1` and
            `100`. Default is `20`.
          required: false
          schema:
            type: integer
            default: 20
        - name: Authorization
          in: header
          description: Basic authentication of the form `Basic <username:password>`.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiAppListResponse'
        '400':
          description: failed_operation
          content: {}
components:
  schemas:
    ApiAppResponseOAuth:
      type: object
      properties:
        callback_url:
          type: string
          description: The app's OAuth callback URL.
        secret:
          type:
            - string
            - 'null'
          description: The app's OAuth secret, or null if the app does not belong to user.
        scopes:
          type: array
          items:
            type: string
          description: Array of OAuth scopes used by the app.
        charges_users:
          type: boolean
          description: >-
            Boolean indicating whether the app owner or the account granting
            permission is billed for OAuth requests.
    ApiAppResponseOptions:
      type: object
      properties:
        can_insert_everywhere:
          type: boolean
          description: >-
            Boolean denoting if signers can "Insert Everywhere" in one click
            while signing a document
    ApiAppResponseOwnerAccount:
      type: object
      properties:
        account_id:
          type: string
          description: The owner account's ID
        email_address:
          type: string
          description: The owner account's email address
    ApiAppResponseWhiteLabelingOptions:
      type: object
      properties:
        header_background_color:
          type: string
        legal_version:
          type: string
        link_color:
          type: string
        page_background_color:
          type: string
        primary_button_color:
          type: string
        primary_button_color_hover:
          type: string
        primary_button_text_color:
          type: string
        primary_button_text_color_hover:
          type: string
        secondary_button_color:
          type: string
        secondary_button_color_hover:
          type: string
        secondary_button_text_color:
          type: string
        secondary_button_text_color_hover:
          type: string
        text_color1:
          type: string
        text_color2:
          type: string
    ApiAppResponse:
      type: object
      properties:
        callback_url:
          type:
            - string
            - 'null'
          description: The app's callback URL (for events)
        client_id:
          type: string
          description: The app's client id
        created_at:
          type: integer
          description: The time that the app was created
        domains:
          type: array
          items:
            type: string
          description: The domain name(s) associated with the app
        name:
          type: string
          description: The name of the app
        is_approved:
          type: boolean
          description: Boolean to indicate if the app has been approved
        oauth:
          $ref: '#/components/schemas/ApiAppResponseOAuth'
        options:
          $ref: '#/components/schemas/ApiAppResponseOptions'
        owner_account:
          $ref: '#/components/schemas/ApiAppResponseOwnerAccount'
        white_labeling_options:
          $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions'
    ListInfoResponse:
      type: object
      properties:
        num_pages:
          type: integer
          description: Total number of pages available.
        num_results:
          type:
            - integer
            - 'null'
          description: Total number of objects available.
        page:
          type: integer
          description: Number of the page being returned.
        page_size:
          type: integer
          description: Objects returned per page.
    WarningResponse:
      type: object
      properties:
        warning_msg:
          type: string
          description: Warning message
        warning_name:
          type: string
          description: Warning name
      required:
        - warning_msg
        - warning_name
    ApiAppListResponse:
      type: object
      properties:
        api_apps:
          type: array
          items:
            $ref: '#/components/schemas/ApiAppResponse'
          description: Contains information about API Apps.
        list_info:
          $ref: '#/components/schemas/ListInfoResponse'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      required:
        - api_apps
        - list_info

```

## SDK Code Examples

```php PHP
<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppList(
        page: 1,
        page_size: 20,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling ApiAppApi#apiAppList: {$e->getMessage()}";
}

```

```csharp C#
using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class ApiAppListExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";
        // config.AccessToken = "YOUR_ACCESS_TOKEN";

        try
        {
            var response = new ApiAppApi(config).ApiAppList(
                page: 1,
                pageSize: 20
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

```

```typescript TypeScript
import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.ApiAppApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

apiCaller.apiAppList(
  1, // page
  20, // pageSize
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling ApiAppApi#apiAppList:");
  console.log(error.body);
});

```

```java Java
package com.dropbox.sign_sandbox;

import com.dropbox.sign.ApiException;
import com.dropbox.sign.Configuration;
import com.dropbox.sign.api.*;
import com.dropbox.sign.auth.*;
import com.dropbox.sign.JSON;
import com.dropbox.sign.model.*;

import java.io.File;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class ApiAppListExample
{
    public static void main(String[] args)
    {
        var config = Configuration.getDefaultApiClient();
        ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY");
        // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN");

        try
        {
            var response = new ApiAppApi(config).apiAppList(
                1, // page
                20 // pageSize
            );

            System.out.println(response);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiAppApi#apiAppList");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

```

```ruby Ruby
require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
    config.username = "YOUR_API_KEY"
    # config.access_token = "YOUR_ACCESS_TOKEN"
end

begin
    response = Dropbox::Sign::ApiAppApi.new.api_app_list(
        {
            page: 1,
            page_size: 20,
        },
    )

    p response
rescue Dropbox::Sign::ApiError => e
    puts "Exception when calling ApiAppApi#api_app_list: #{e}"
end

```

```python Python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
    username="YOUR_API_KEY",
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    try:
        response = api.ApiAppApi(api_client).api_app_list(
            page=1,
            page_size=20,
        )

        pprint(response)
    except ApiException as e:
        print("Exception when calling ApiAppApi#api_app_list: %s\n" % e)

```

```go API App List
package main

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

func main() {

	url := "https://api.hellosign.com/v3/api_app/list"

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

	req.Header.Add("Authorization", "Basic <apiKey>:<password>")

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

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

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

}
```

```swift API App List
import Foundation

let headers = ["Authorization": "Basic <apiKey>:<password>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hellosign.com/v3/api_app/list")! 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()
```