## List accounts

`$ straddle embed:accounts list`

**get** `/v1/accounts`

Returns a list of accounts associated with your Straddle platform integration. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. This endpoint supports advanced sorting and filtering options.

### Parameters

- `--external-id: optional string`

  Query param

- `--page-number: optional number`

  Query param: Results page number. Starts at page 1. Default value: 1

- `--page-size: optional number`

  Query param: Page size. Default value: 100. Max value: 1000

- `--search-text: optional string`

  Query param

- `--sort-by: optional string`

  Query param: Sort By. Default value: 'id'.

- `--sort-order: optional "asc" or "desc"`

  Query param: Sort Order. Default value: 'asc'.

- `--status: optional "created" or "onboarding" or "active" or 2 more`

  Query param

- `--type: optional "business"`

  Query param

- `--correlation-id: optional string`

  Header param: Optional client generated identifier to trace and debug a series of requests.

- `--request-id: optional string`

  Header param: Optional client generated identifier to trace and debug a request.

### Returns

- `accountPagedV1: object { data, meta, response_type }`

  - `data: array of object { id, access_level, organization_id, 11 more }`

    - `id: string`

      Unique identifier for the account.

    - `access_level: "standard" or "managed"`

      The access level granted to the account. This is determined by your platform configuration. Use `standard` unless instructed otherwise by Straddle.

      - `"standard"`

      - `"managed"`

    - `organization_id: string`

      The unique identifier of the organization this account belongs to.

    - `status: "created" or "onboarding" or "active" or 2 more`

      The current status of the account (e.g., 'active', 'inactive', 'pending').

      - `"created"`

      - `"onboarding"`

      - `"active"`

      - `"rejected"`

      - `"inactive"`

    - `status_detail: object { code, message, reason, source }`

      - `code: string`

        A machine-readable code for the specific status, useful for programmatic handling.

      - `message: string`

        A human-readable message describing the current status.

      - `reason: "unverified" or "in_review" or "pending" or 6 more`

        A machine-readable identifier for the specific status, useful for programmatic handling.

        - `"unverified"`

        - `"in_review"`

        - `"pending"`

        - `"stuck"`

        - `"verified"`

        - `"failed_verification"`

        - `"disabled"`

        - `"terminated"`

        - `"new"`

      - `source: "watchtower"`

        Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`). This helps in tracking the cause of status updates.

        - `"watchtower"`

    - `type: "business"`

      The type of account (e.g., 'individual', 'business').

      - `"business"`

    - `business_profile: optional object { name, website, address, 7 more }`

      - `name: string`

        The operating or trade name of the business.

      - `website: string`

        URL of the business's primary marketing website.

      - `address: optional object { address1, city, line1, 6 more }`

        The address object is optional. If provided, it must be a valid address.

        - `address1: string`

          Primary address line (e.g., street, PO Box).

        - `city: string`

          City, district, suburb, town, or village.

        - `line1: string`

          Primary address line (e.g., street, PO Box).

        - `postal_code: string`

          Postal or ZIP code.

        - `state: string`

          Two-letter state code.

        - `zip: string`

          Zip or postal code.

        - `address2: optional string`

          Secondary address line (e.g., apartment, suite, unit, or building).

        - `country: optional string`

          The country of the address, in ISO 3166-1 alpha-2 format.

        - `line2: optional string`

          Secondary address line (e.g., apartment, suite, unit, or building).

      - `description: optional string`

        A brief description of the business and its products or services.

      - `industry: optional object { category, mcc, sector }`

        - `category: optional string`

          The general category of the industry. Required if not providing MCC.

        - `mcc: optional string`

          The Merchant Category Code (MCC) that best describes the business. Optional.

        - `sector: optional string`

          The specific sector within the industry category. Required if not providing MCC.

      - `legal_name: optional string`

        The official registered name of the business.

      - `phone: optional string`

        The primary contact phone number for the business.

      - `support_channels: optional object { email, phone, url }`

        - `email: optional string`

          The email address for customer support inquiries.

        - `phone: optional string`

          The phone number for customer support.

        - `url: optional string`

          The URL of the business's customer support page or contact form.

      - `tax_id: optional string`

        The business's tax identification number (e.g., EIN in the US).

      - `use_case: optional string`

        A description of how the business intends to use Straddle's services.

    - `capabilities: optional object { consent_types, customer_types, payment_types }`

      - `consent_types: object { internet, signed_agreement }`

        - `internet: object { capability_status }`

          Whether the internet payment authorization capability is enabled for the account.

          - `capability_status: "active" or "inactive"`

            - `"active"`

            - `"inactive"`

        - `signed_agreement: object { capability_status }`

          Whether the signed agreement payment authorization capability is enabled for the account.

          - `capability_status: "active" or "inactive"`

      - `customer_types: object { businesses, individuals }`

        - `businesses: object { capability_status }`

          - `capability_status: "active" or "inactive"`

        - `individuals: object { capability_status }`

          - `capability_status: "active" or "inactive"`

      - `payment_types: object { charges, payouts }`

        - `charges: object { capability_status }`

          - `capability_status: "active" or "inactive"`

        - `payouts: object { capability_status }`

          - `capability_status: "active" or "inactive"`

    - `created_at: optional string`

      Timestamp of when the account was created.

    - `external_id: optional string`

      Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.

    - `metadata: optional map[string]`

      Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format.

    - `settings: optional object { charges, payouts }`

      - `charges: object { daily_amount, funding_time, linked_bank_account_id, 3 more }`

        - `daily_amount: number`

          The maximum dollar amount of charges in a calendar day.

        - `funding_time: "immediate" or "next_day" or "one_day" or 4 more`

          The amount of time it takes for a charge to be funded. This value is defined by Straddle.

          - `"immediate"`

          - `"next_day"`

          - `"one_day"`

          - `"two_day"`

          - `"three_day"`

          - `"four_day"`

          - `"five_day"`

        - `linked_bank_account_id: string`

          The unique identifier of the linked bank account associated with charges. This value is defined by Straddle.

        - `max_amount: number`

          The maximum amount of a single charge.

        - `monthly_amount: number`

          The maximum dollar amount of charges in a calendar month.

        - `monthly_count: number`

          The maximum number of charges in a calendar month.

      - `payouts: object { daily_amount, funding_time, linked_bank_account_id, 3 more }`

        - `daily_amount: number`

          The maximum dollar amount of payouts in a day.

        - `funding_time: "immediate" or "next_day" or "one_day" or 4 more`

          The amount of time it takes for a payout to be funded. This value is defined by Straddle.

          - `"immediate"`

          - `"next_day"`

          - `"one_day"`

          - `"two_day"`

          - `"three_day"`

          - `"four_day"`

          - `"five_day"`

        - `linked_bank_account_id: string`

          The unique identifier of the linked bank account to use for payouts.

        - `max_amount: number`

          The maximum amount of a single payout.

        - `monthly_amount: number`

          The maximum dollar amount of payouts in a month.

        - `monthly_count: number`

          The maximum number of payouts in a month.

    - `terms_of_service: optional object { accepted_date, agreement_type, agreement_url, 2 more }`

      - `accepted_date: string`

        The datetime of when the terms of service were accepted, in ISO 8601 format.

      - `agreement_type: "embedded" or "direct"`

        The type or version of the agreement accepted. Use `embedded` unless your platform was specifically enabled for `direct` agreements.

        - `"embedded"`

        - `"direct"`

      - `agreement_url: string`

        The URL where the full text of the accepted agreement can be found.

      - `accepted_ip: optional string`

        The IP address from which the terms of service were accepted.

      - `accepted_user_agent: optional string`

        The user agent string of the browser or application used to accept the terms.

    - `updated_at: optional string`

      Timestamp of the most recent update to the account.

  - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }`

    Metadata about the API request, including an identifier, timestamp, and pagination details.

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

      Total number of items returned in this response.

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "none"`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```cli
straddle embed:accounts list \
  --api-key 'My API Key'
```

#### Response

```json
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "access_level": "standard",
      "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": "created",
      "status_detail": {
        "code": "code",
        "message": "message",
        "reason": "unverified",
        "source": "watchtower"
      },
      "type": "business",
      "business_profile": {
        "name": "name",
        "website": "https://example.com",
        "address": {
          "address1": "address1",
          "city": "city",
          "line1": "line1",
          "postal_code": "21029-1360",
          "state": "SE",
          "zip": "zip",
          "address2": "address2",
          "country": "country",
          "line2": "line2"
        },
        "description": "description",
        "industry": {
          "category": "category",
          "mcc": "mcc",
          "sector": "sector"
        },
        "legal_name": "legal_name",
        "phone": "+46991022",
        "support_channels": {
          "email": "dev@stainless.com",
          "phone": "+46991022",
          "url": "https://example.com"
        },
        "tax_id": "210297980",
        "use_case": "use_case"
      },
      "capabilities": {
        "consent_types": {
          "internet": {
            "capability_status": "active"
          },
          "signed_agreement": {
            "capability_status": "active"
          }
        },
        "customer_types": {
          "businesses": {
            "capability_status": "active"
          },
          "individuals": {
            "capability_status": "active"
          }
        },
        "payment_types": {
          "charges": {
            "capability_status": "active"
          },
          "payouts": {
            "capability_status": "active"
          }
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      },
      "settings": {
        "charges": {
          "daily_amount": 0,
          "funding_time": "immediate",
          "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "max_amount": 0,
          "monthly_amount": 0,
          "monthly_count": 0
        },
        "payouts": {
          "daily_amount": 0,
          "funding_time": "immediate",
          "linked_bank_account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "max_amount": 0,
          "monthly_amount": 0,
          "monthly_count": 0
        }
      },
      "terms_of_service": {
        "accepted_date": "2019-12-27T18:11:19.117Z",
        "agreement_type": "embedded",
        "agreement_url": "agreement_url",
        "accepted_ip": "accepted_ip",
        "accepted_user_agent": "accepted_user_agent"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}
```