## List accounts

`embed.accounts.list(AccountListParams**kwargs)  -> SyncPageNumberSchema[Data]`

**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

- `page_number: Optional[int]`

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

- `page_size: Optional[int]`

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

- `search_text: Optional[str]`

- `sort_by: Optional[str]`

  Sort By. Default value: 'id'.

- `sort_order: Optional[Literal["asc", "desc"]]`

  Sort Order. Default value: 'asc'.

  - `"asc"`

  - `"desc"`

- `status: Optional[Literal["created", "onboarding", "active", 2 more]]`

  - `"created"`

  - `"onboarding"`

  - `"active"`

  - `"rejected"`

  - `"inactive"`

- `type: Optional[Literal["business"]]`

  - `"business"`

- `correlation_id: Optional[str]`

- `request_id: Optional[str]`

### Returns

- `Data`

  - `id: str`

    Unique identifier for the account.

  - `access_level: Literal["standard", "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: str`

    The unique identifier of the organization this account belongs to.

  - `status: Literal["created", "onboarding", "active", 2 more]`

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

    - `"created"`

    - `"onboarding"`

    - `"active"`

    - `"rejected"`

    - `"inactive"`

  - `status_detail: DataStatusDetail`

    - `code: str`

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

    - `message: str`

      A human-readable message describing the current status.

    - `reason: Literal["unverified", "in_review", "pending", 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: Literal["watchtower"]`

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

      - `"watchtower"`

  - `type: Literal["business"]`

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

    - `"business"`

  - `business_profile: Optional[BusinessProfileV1]`

    - `name: str`

      The operating or trade name of the business.

    - `website: str`

      URL of the business's primary marketing website.

    - `address: Optional[AddressV1]`

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

      - `city: Optional[str]`

        City, district, suburb, town, or village.

      - `line1: Optional[str]`

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

      - `postal_code: Optional[str]`

        Postal or ZIP code.

      - `state: Optional[str]`

        Two-letter state code.

      - `country: Optional[str]`

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

      - `line2: Optional[str]`

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

    - `description: Optional[str]`

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

    - `industry: Optional[IndustryV1]`

      - `category: Optional[str]`

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

      - `mcc: Optional[str]`

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

      - `sector: Optional[str]`

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

    - `legal_name: Optional[str]`

      The official registered name of the business.

    - `phone: Optional[str]`

      The primary contact phone number for the business.

    - `support_channels: Optional[SupportChannelsV1]`

      - `email: Optional[str]`

        The email address for customer support inquiries.

      - `phone: Optional[str]`

        The phone number for customer support.

      - `url: Optional[str]`

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

    - `tax_id: Optional[str]`

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

    - `use_case: Optional[str]`

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

  - `capabilities: Optional[DataCapabilities]`

    - `consent_types: DataCapabilitiesConsentTypes`

      - `internet: CapabilityV1`

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

        - `capability_status: Literal["active", "inactive"]`

          - `"active"`

          - `"inactive"`

      - `signed_agreement: CapabilityV1`

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

    - `customer_types: DataCapabilitiesCustomerTypes`

      - `businesses: CapabilityV1`

      - `individuals: CapabilityV1`

    - `payment_types: DataCapabilitiesPaymentTypes`

      - `charges: CapabilityV1`

      - `payouts: CapabilityV1`

  - `created_at: Optional[datetime]`

    Timestamp of when the account was created.

  - `external_id: Optional[str]`

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

  - `metadata: Optional[Dict[str, Optional[str]]]`

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

  - `settings: Optional[DataSettings]`

    - `charges: DataSettingsCharges`

      - `daily_amount: int`

        The maximum dollar amount of charges in a calendar day.

      - `funding_time: Literal["immediate", "next_day", "one_day", 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: str`

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

      - `max_amount: int`

        The maximum amount of a single charge.

      - `monthly_amount: int`

        The maximum dollar amount of charges in a calendar month.

      - `monthly_count: int`

        The maximum number of charges in a calendar month.

    - `payouts: DataSettingsPayouts`

      - `daily_amount: int`

        The maximum dollar amount of payouts in a day.

      - `funding_time: Literal["immediate", "next_day", "one_day", 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: str`

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

      - `max_amount: int`

        The maximum amount of a single payout.

      - `monthly_amount: int`

        The maximum dollar amount of payouts in a month.

      - `monthly_count: int`

        The maximum number of payouts in a month.

  - `terms_of_service: Optional[TermsOfServiceV1]`

    - `accepted_date: datetime`

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

    - `agreement_type: Literal["embedded", "direct"]`

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

      - `"embedded"`

      - `"direct"`

    - `agreement_url: Optional[str]`

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

    - `accepted_ip: Optional[str]`

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

    - `accepted_user_agent: Optional[str]`

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

  - `updated_at: Optional[datetime]`

    Timestamp of the most recent update to the account.

### Example

```python
import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
page = client.embed.accounts.list()
page = page.data[0]
print(page.id)
```

#### 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": {
          "city": "city",
          "line1": "line1",
          "postal_code": "21029-1360",
          "state": "SE",
          "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"
}
```