Skip to content

waldur-cli team customer list

List customers (organizations).

Usage

1
waldur-cli team customer list [OPTIONS]
Flag Type Description
--filter KEY=VALUE repeatable Server-side filter. Valid keys: abbreviation (string), accounting_is_running (boolean), agreement_number (string), archived (boolean), backend_id (string), contact_details (string), current_user_has_project_create_permission (boolean), has_resources (string), is_call_managing_organization (boolean), is_service_provider (boolean), name (string), name_exact (string), native_name (string), organization_group_name (string), organization_group_uuid (string), owned_by_current_user (boolean), query (string), registration_code (string), service_provider_uuid (string), slug (string), user_uuid (string).
--fields FIELDS string Fetch only these fields from the server (comma-separated). Valid: abbreviation, access_subnets, accounting_start_date, address, agreement_number, apartment_nr, archived, backend_id, bank_account, bank_name, billing_price_estimate, blocked, call_managing_organization_uuid, city, contact_details, country, country_name, created, customer_credit, customer_unallocated_credit, default_affiliations, default_tax_percent, description, display_billing_info_in_projects, display_name, domain, email, grace_period_days, homepage, house_nr, household, image, is_service_provider, latitude, longitude, max_service_accounts, name, native_name, notification_emails, organization_groups, parish, payment_profiles, phone_number, postal, project_metadata_checklist, project_slug_template, projects_count, registration_code, service_provider, service_provider_uuid, slug, sponsor_number, state, street, url, user_affiliations, user_email_patterns, user_identity_sources, users_count, uuid, vat_code.
--order FIELDS string Sort server-side (comma-separated, - prefix for descending).
--jmespath EXPR string Reshape the already-fetched result client-side (https://jmespath.org).
--limit N integer Stop after this many items.
--format FORMAT string table, json, tsv, toon, or ndjson.

Examples

1
waldur-cli team customer list --filter name_exact=example --fields uuid,name --format json

Project just the columns you need, client-side:

1
waldur-cli team customer list --jmespath '[].[uuid, name]'

Smallest/first result matching a filter, sorted server-side:

1
waldur-cli team customer list --order uuid --limit 1

Global options

Every command also accepts --api-url, --token, --profile, --format, and --debug; mutating commands additionally accept --dry-run. See Getting started for what each does.