---
title: "List user profiles"
method: GET
path: "/profiles"
tags: ["User Profiles"]
---

# List user profiles

`GET /profiles`

## Response `200`

The list of user profiles.

- object
  - `count` integer — Total number of results.
  - `profiles` Profile[] — Array of user profiles.
    - `id` string, uuid — The user's unique ID.
    - `display_name` string — The user's display name.
    - `email` string, email — The user's email address.
    - `username` string — The user's username.
    - `type` 'user' | 'organization' — The user's type (user/organization).
    - `picture` string, url — The URL of the user's picture.
    - `company_type` string — The company type.
    - `company_name` string — The name of the company.
    - `currency` string — A 3-letter ISO 4217 currency code (assigned according to the billing address).
    - `vat_number` string — The vat number of the user.
    - `company_role` string — The role of the user in the company.
    - `website_url` string — The user or company website.
    - `new_ui` boolean — Whether the new UI features are enabled for this user.
    - `ui_colorscheme` string — The user's chosen color scheme for user interfaces.
    - `default_catalog` string — The URL of a catalog file which overrides the default.
    - `project_options_url` string — The URL of an account-wide project options file.
    - `marketing` boolean — Flag if the user agreed to receive marketing communication.
    - `created_at` string, date-time — The timestamp representing when the user account was created.
    - `updated_at` string, date-time — The timestamp representing when the user account was last modified.
    - `billing_contact` string, email — The e-mail address of a contact to whom billing notices will be sent.
    - `current_trial` object — The current trial for the profile.
      - `active` boolean — The trial active status.
      - `created` string, date-time — The trial creation date.
      - `description` string — The trial description.
      - `expiration` string, date-time — The trial expiration-date.
      - `current` object — The total amount spent by the trial user at this point in time.
        - `formatted` string — The total amount formatted.
        - `amount` string — The total amount.
        - `currency` string — The currency.
        - `currency_symbol` string — Currency symbol.
      - `spend` object — The total amount available for the trial.
        - `formatted` string — The total amount formatted.
        - `amount` string — The total amount.
        - `currency` string — The currency.
        - `currency_symbol` string — Currency symbol.
      - `spend_remaining` object — The remaining amount available for the trial.
        - `formatted` string — The total amount formatted.
        - `amount` string — The total amount.
        - `currency` string — The currency.
        - `currency_symbol` string — Currency symbol.
        - `unlimited` boolean — Spend limit is ignored (in favor of resource limitations).
      - `projects` object — Projects active under trial
        - `id` string — Trial project ID
        - `name` string — Trial project name
        - `total` object
          - `amount` integer — Trial project cost
          - `currency_code` string — Currency code
          - `currency_symbol` string — Currency symbol
          - `formatted` string — Trial project cost formatted with currency sign
      - `pending_verification` 'credit-card', nullable — Required verification method (if applicable).
      - `model` string — The trial trial model.
      - `days_remaining` integer — The amount of days until the trial expires.
    - `invoiced` boolean — The customer is invoiced.
  - `_links` HalLinks — Links to _self, and previous or next page, given that they exist.
    - `self` object — The cardinal link to the self resource.
      - `title` string — Title of the link
      - `href` string — URL of the link
    - `previous` object — The link to the previous resource page, given that it exists.
      - `title` string — Title of the link
      - `href` string — URL of the link
    - `next` object — The link to the next resource page, given that it exists.
      - `title` string — Title of the link
      - `href` string — URL of the link

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)