Skip to main content
GET
/
accounts
List Accounts
curl --request GET \
  --url https://{defaultHost}/accounts \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "accounts": [
    {
      "id": "<string>",
      "email": "<string>",
      "title": "<string>",
      "description": "<string>",
      "route": "<string>",
      "logo_url": "<string>",
      "banner_image_url": "<string>",
      "business_type": "<string>",
      "country": "<string>",
      "home_preferences": [
        "<string>"
      ],
      "industry_group": "<string>",
      "industry_type": "<string>",
      "invoice_prefix": "<string>",
      "onboarding_type": "<string>",
      "opengraph_image_url": "<string>",
      "opengraph_image_variant": "<string>",
      "other_business_description": "<string>",
      "other_industry_description": "<string>",
      "require_2fa": true,
      "target_audience": "<string>",
      "send_customer_emails": true,
      "show_joined_whops": true,
      "show_reviews_dtc": true,
      "show_user_directory": true,
      "store_page_config": {},
      "parent_account_id": "<string>",
      "metadata": {},
      "created_at": "<string>",
      "use_logo_as_opengraph_image_fallback": true,
      "wallet": {
        "id": "<string>",
        "address": "<string>"
      },
      "social_links": [
        {
          "id": "<string>",
          "url": "<string>",
          "title": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token.

Query Parameters

page
integer
default:1

The page number to retrieve

per
integer
default:10

The number of resources to return per page. There is a limit of 50 results per page.

Response

accounts listed

pagination
object
required
accounts
object[]
required