> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt > Use this file to discover all available pages before exploring further. # List clients > Returns a list of clients. Uses cursor pagination. ## OpenAPI ````yaml /openapi-private.json get /clients openapi: 3.1.0 info: title: Spott API Reference version: '0.1' servers: - url: https://api.gospott.com security: [] tags: [] paths: /clients: get: tags: - Clients summary: List clients description: Returns a list of clients. Uses cursor pagination. operationId: getClients parameters: - name: limit required: false in: query description: 'Number of clients to return per page (min: 1, max: 50, default: 25).' schema: minimum: 1 maximum: 50 default: 25 example: 25 type: integer - name: cursor required: false in: query description: >- Base64-encoded cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. Omit for the first page. schema: example: >- eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjb21wYW55LTEyMyJ9 type: string - name: modifiedSince required: false in: query description: >- Filter clients by sync watermark on or after this date. Useful for incremental synchronization. Defaults to beginning of time if not provided. schema: $ref: '#/components/schemas/DateISO' default: '1970-01-01T00:00:00.000Z' example: '2024-11-01T00:00:00.000Z' - name: modifiedUntil required: false in: query description: >- Filter clients by sync watermark on or before this date. Useful for bounded synchronization snapshots. If omitted, no upper bound is applied. schema: $ref: '#/components/schemas/DateISO' example: '2024-11-30T23:59:59.999Z' - name: listIds required: false in: query description: Filter clients by client list IDs. schema: minItems: 1 maxItems: 25 uniqueItems: true example: - client-list-123 - client-list-456 type: array items: type: string responses: '200': description: >- Successfully retrieved clients. Returns items array with pagination info containing cursor for the next page. content: application/json: schema: $ref: '#/components/schemas/GetClientsResponseDto' '400': description: >- Bad request - invalid query parameters (e.g., limit out of range, invalid date format) content: application/json: schema: allOf: - $ref: '#/components/schemas/ExceptionBaseDto' - type: object properties: statusCode: type: number example: 400 message: type: string example: Limit must be between 1 and 50 error: type: string example: Bad Request '401': description: Unauthorized - invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' '500': description: Error response content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' security: - x-api-key: [] components: schemas: DateISO: id: DateISO format: date-time anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ GetClientsResponseDto: type: object properties: items: type: array items: $ref: '#/components/schemas/ClientBaseDto' pageInfo: $ref: '#/components/schemas/CursorPageInfoDto' required: - items - pageInfo id: PrivateGetClientsResponseDto ExceptionBaseDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 message: type: string requestId: type: string required: - status - message - requestId id: ExceptionBaseDto ClientBaseDto: type: object properties: id: type: string minLength: 1 description: Unique identifier for the client (company ID) status: $ref: '#/components/schemas/ClientStatusTypeDto' description: Client status name: $ref: '#/components/schemas/ClientNameTypeDto' description: Client/company name and avatar description: $ref: '#/components/schemas/ClientDescriptionTypeDto' description: Company description industry: $ref: '#/components/schemas/ClientIndustryTypeDto' description: Industry classification domain: $ref: '#/components/schemas/ClientDomainTypeDto' description: Company website domain linkedinUrl: $ref: '#/components/schemas/ClientLinkedinUrlTypeDto' description: LinkedIn company page URL size: $ref: '#/components/schemas/ClientSizeTypeDto' description: Company size (e.g. employee count band) stage: $ref: '#/components/schemas/ClientStageTypeDto' description: Pipeline stage for this client nextTaskDue: $ref: '#/components/schemas/ClientNextTaskDueTypeDto' description: Next task due for this client locations: $ref: '#/components/schemas/ClientLocationsTypeDto' description: Company locations customAttributes: type: array items: $ref: '#/components/schemas/CustomAttributeItemDto' description: Custom attribute values for this client taxIdentifiers: type: array items: $ref: '#/components/schemas/ClientTaxIdentifierDto' description: Tax identifiers registered for this client createdBy: anyOf: - $ref: '#/components/schemas/UserBadgeDto' - type: 'null' description: User who created the client createdAt: $ref: '#/components/schemas/DateISO' description: Timestamp when the client was created modifiedAt: $ref: '#/components/schemas/DateISO' description: Timestamp when the client was last modified required: - id - status - name - description - industry - domain - linkedinUrl - size - stage - nextTaskDue - locations - customAttributes - taxIdentifiers - createdBy - createdAt - modifiedAt id: PrivateClientBaseDto CursorPageInfoDto: type: object properties: nextCursor: anyOf: - type: string - type: 'null' deprecated: true description: 'Deprecated: use pagination.cursor instead.' hasNextPage: type: boolean deprecated: true description: 'Deprecated: use the presence of pagination.cursor instead.' required: - nextCursor - hasNextPage id: CursorPageInfoDto ClientStatusTypeDto: type: object properties: viewType: type: string enum: - clientStatus status: anyOf: - type: string enum: - lead - prospect - customer - lost_customer - blacklisted - type: 'null' required: - viewType - status id: PrivateClientStatusTypeDto ClientNameTypeDto: type: object properties: viewType: type: string enum: - clientName name: type: string avatarUrl: anyOf: - type: string - type: 'null' required: - viewType - name - avatarUrl id: PrivateClientNameTypeDto ClientDescriptionTypeDto: type: object properties: viewType: type: string enum: - clientDescription description: anyOf: - type: string - type: 'null' required: - viewType - description id: PrivateClientDescriptionTypeDto ClientIndustryTypeDto: type: object properties: viewType: type: string enum: - clientIndustry industry: anyOf: - type: string enum: - Accessible Architecture and Design - Accessible Hardware Manufacturing - Accommodation and Food Services - Accounting - Administration of Justice - Administrative and Support Services - Advertising Services - Agricultural Chemical Manufacturing - Agriculture, Construction, Mining Machinery Manufacturing - Air, Water and Waste Program Management - Aviation & Aerospace - Airlines and Aviation - Abrasives and Nonmetallic Minerals Manufacturing - Alternative Dispute Resolution - Alternative Fuel Vehicle Manufacturing - Alternative Medicine - Ambulance Services - Amusement Parks and Arcades - Animal Feed Manufacturing - Animation - Animation and Post-production - Apparel Manufacturing - Apparel & Fashion - Appliances, Electrical, and Electronics Manufacturing - Architecture and Planning - Architectural and Structural Metal Manufacturing - Armed Forces - Artificial Rubber and Synthetic Fiber Manufacturing - Artists and Writers - Arts & Crafts - Audio and Video Equipment Manufacturing - Automation Machinery Manufacturing - Automotive - Aviation and Aerospace Component Manufacturing - Baked Goods Manufacturing - Banking - Bars, Taverns and Nightclubs - Bed and Breakfasts, Hostels, Homestays - Beverage Manufacturing - Biomass Electric Power Generation - Biotechnology - Biotechnology Research - Blockchain Services - Blogs - Boilers, Tanks, and Shipping Container Manufacturing - Book and Periodical Publishing - Book Publishing - Breweries - Broadcast Media Production and Distribution - Building Construction - Building Equipment Contractors - Building Finishing Contractors - Building Materials - Building Structure and Exterior Contractors - Business Consulting and Services - Business Content - Business Intelligence Platforms - Business Supplies & Equipment - Cable and Satellite Programming - Capital Markets - Caterers - Chemical Manufacturing - Chemical Raw Materials Manufacturing - Child Day Care Services - Chiropractors - Circuses and Magic Shows - Civic and Social Organizations - Civil Engineering - Claims Adjusting, Actuarial Services - Clay and Refractory Products Manufacturing - Climate Data and Analytics - Climate Technology Product Manufacturing - Coal Mining - Collection Agencies - Commercial and Industrial Equipment Rental - Commercial and Industrial Machinery Maintenance - Commercial and Service Industry Machinery Manufacturing - Commercial Real Estate - Communications Equipment Manufacturing - Community Development and Urban Planning - Community Services - Computer and Network Security - Computer Games - Computer Hardware - Computer Hardware Manufacturing - Computer Networking - Computer Networking Products - Computers and Electronics Manufacturing - Conservation Programs - Construction - Construction Hardware Manufacturing - Consumer Electronics - Consumer Goods - Consumer Goods Rental - Consumer Services - Correctional Institutions - Cosmetics - Cosmetology and Barber Schools - Courts of Law - Credit Intermediation - Cutlery and Handtool Manufacturing - Dairy - Dairy Product Manufacturing - Dance Companies - Data Infrastructure and Analytics - Data Security Software Products - Defense and Space Manufacturing - Defense & Space - Dentists - Design - Design Services - Desktop Computing Software Products - Digital Accessibility Services - Distilleries - E-learning - E-Learning Providers - Economic Programs - Education - Education Administration Programs - Education Management - Electric Lighting Equipment Manufacturing - Electric Power Generation - Electric Power Transmission, Control, and Distribution - Electrical Equipment Manufacturing - Electronic and Precision Equipment Maintenance - Embedded Software Products - Emergency and Relief Services - Energy Technology - Engineering Services - Engines and Power Transmission Equipment Manufacturing - Entertainment - Entertainment Providers - Environmental Quality Programs - Environmental Services - Equipment Rental Services - Events Services - Executive Offices - Executive Search Services - Fabricated Metal Products - Facilities Services - Family Planning Centers - Farming - Farming, Ranching, Forestry - Fashion Accessories Manufacturing - Financial Services - Fine Art - Fine Arts Schools - Fire Protection - Fisheries - Flight Training - Food and Beverage Manufacturing - Food and Beverage Retail - Food and Beverage Services - Food & Beverages - Food Production - Footwear and Leather Goods Repair - Footwear Manufacturing - Forestry and Logging - Fossil Fuel Electric Power Generation - Freight and Package Transportation - Fruit and Vegetable Preserves Manufacturing - Fuel Cell Manufacturing - Fundraising - Funds and Trusts - Furniture - Furniture and Home Furnishings Manufacturing - Gambling Facilities and Casinos - Geothermal Electric Power Generation - Glass Product Manufacturing - Glass, Ceramics and Concrete Manufacturing - Golf Courses and Country Clubs - Government Administration - Government Relations - Government Relations Services - Graphic Design - Ground Passenger Transportation - Health and Human Services - Health, Wellness & Fitness - Higher Education - Highway, Street, and Bridge Construction - Historical Sites - Holding Companies - Home Health Care Services - Horticulture - Hospitality - Hospitals - Hospitals and Health Care - Hotels and Motels - Household Appliance Manufacturing - Household and Institutional Furniture Manufacturing - Household Services - Housing and Community Development - Housing Programs - Human Resources - Human Resources Services - HVAC and Refrigeration Equipment Manufacturing - Hydroelectric Power Generation - Import & Export - Individual and Family Services - Industrial Automation - Industrial Machinery Manufacturing - Industry Associations - Information Services - Information Technology & Services - Insurance - Insurance Agencies and Brokerages - Insurance and Employee Benefit Funds - Insurance Carriers - Interior Design - International Affairs - International Trade and Development - Internet Marketplace Platforms - Internet News - Internet Publishing - Interurban and Rural Bus Services - Investment Advice - Investment Banking - Investment Management - IT Services and IT Consulting - IT System Custom Software Development - IT System Data Services - IT System Design Services - IT System Installation and Disposal - IT System Operations and Maintenance - IT System Testing and Evaluation - IT System Training and Support - Janitorial Services - Landscaping Services - Language Schools - Laundry and Drycleaning Services - Law Enforcement - Law Practice - Leasing Non-residential Real Estate - Leasing Residential Real Estate - Leather Product Manufacturing - Legal Services - Legislative Offices - Leisure, Travel & Tourism - Libraries - Lime and Gypsum Products Manufacturing - Loan Brokers - Luxury Goods & Jewelry - Machinery Manufacturing - Magnetic and Optical Media Manufacturing - Manufacturing - Maritime - Maritime Transportation - Marketing Services - Market Research - Mattress and Blinds Manufacturing - Measuring and Control Instrument Manufacturing - Meat Products Manufacturing - Mechanical Or Industrial Engineering - Media and Telecommunications - Media Production - Medical and Diagnostic Laboratories - Medical Device - Medical Equipment Manufacturing - Medical Practices - Mental Health Care - Metal Ore Mining - Metal Treatments - Metal Valve, Ball, and Roller Manufacturing - Metalworking Machinery Manufacturing - Military and International Affairs - Mining - Mobile Computing Software Products - Mobile Food Services - Mobile Gaming Apps - Motor Vehicle Manufacturing - Motor Vehicle Parts Manufacturing - Movies and Sound Recording - Movies, Videos, and Sound - Museums - Museums, Historical Sites, and Zoos - Music - Musicians - Nanotechnology Research - Natural Gas Distribution - Natural Gas Extraction - Newspaper Publishing - Nonmetallic Mineral Mining - Non-profit Organization Management - Non-profit Organizations - Nonresidential Building Construction - Nuclear Electric Power Generation - Nursing Homes and Residential Care Facilities - Office Administration - Office Furniture and Fixtures Manufacturing - Oil and Coal Product Manufacturing - Oil and Gas - Oil Extraction - Oil, Gas, and Mining - Online and Mail Order Retail - Online Audio and Video Media - Online Media - Operations Consulting - Optometrists - Outpatient Care Centers - Outsourcing and Offshoring Consulting - Outsourcing/Offshoring - Packaging and Containers Manufacturing - Packaging & Containers - Paint, Coating, and Adhesive Manufacturing - Paper and Forest Product Manufacturing - Paper & Forest Products - Pension Funds - Performing Arts - Performing Arts and Spectator Sports - Periodical Publishing - Personal and Laundry Services - Personal Care Product Manufacturing - Personal Care Services - Pet Services - Pharmaceutical Manufacturing - Philanthropic Fundraising Services - Philanthropy - Photography - Physical, Occupational and Speech Therapists - Physicians - Pipeline Transportation - Plastics and Rubber Product Manufacturing - Plastics Manufacturing - Political Organizations - Postal Services - Primary and Secondary Education - Primary Metal Manufacturing - Printing Services - Professional Organizations - Professional Services - Professional Training and Coaching - Program Development - Public Assistance Programs - Public Health - Public Policy - Public Policy Offices - Public Relations and Communications Services - Public Safety - Racetracks - Radio and Television Broadcasting - Rail Transportation - Railroad Equipment Manufacturing - Ranching - Ranching and Fisheries - Real Estate - Real Estate Agents and Brokers - Real Estate and Equipment Rental Services - Recreational Facilities - Regenerative Design - Religious Institutions - Renewable Energy Equipment Manufacturing - Renewable Energy Power Generation - Renewable Energy Semiconductor Manufacturing - Renewables & Environment - Repair and Maintenance - Research - Research Services - Residential Building Construction - Restaurants - Retail - Retail Apparel and Fashion - Retail Appliances, Electrical, and Electronic Equipment - Retail Art Dealers - Retail Art Supplies - Retail Books and Printed News - Retail Building Materials and Garden Equipment - Retail Florists - Retail Furniture and Home Furnishings - Retail Gasoline - Retail Groceries - Retail Health and Personal Care Products - Retail Luxury Goods and Jewelry - Retail Motor Vehicles - Retail Musical Instruments - Retail Office Equipment - Retail Office Supplies and Gifts - Retail Pharmacies - Retail Recyclable Materials & Used Merchandise - Reupholstery and Furniture Repair - Robotics Engineering - Robot Manufacturing - Rubber Products Manufacturing - Satellite Telecommunications - Savings Institutions - School and Employee Bus Services - Seafood Product Manufacturing - Secretarial Schools - Securities and Commodity Exchanges - Security and Investigations - Security Guards and Patrol Services - Security Systems Services - Semiconductor Manufacturing - Semiconductors - Services for Renewable Energy - Services for the Elderly and Disabled - Sheet Music Publishing - Shipbuilding - Shuttles and Special Needs Transportation Services - Sightseeing Transportation - Skiing Facilities - Smart Meter Manufacturing - Soap and Cleaning Product Manufacturing - Social Networking Platforms - Software Development - Solar Electric Power Generation - Sound Recording - Space Research and Technology - Specialty Trade Contractors - Spectator Sports - Sporting Goods - Sporting Goods Manufacturing - Sports and Recreation Instruction - Sports Teams and Clubs - Spring and Wire Product Manufacturing - Staffing and Recruiting - Steam and Air-Conditioning Supply - Strategic Management Services - Subdivision of Land - Sugar and Confectionery Product Manufacturing - Surveying and Mapping Services - Taxi and Limousine Services - Technical and Vocational Training - Technology, Information and Internet - Technology, Information and Media - Telecommunications - Telecommunications Carriers - Telephone Call Centers - Temporary Help Services - Textile Manufacturing - Theater Companies - Think Tanks - Tobacco - Tobacco Manufacturing - Translation and Localization - Transportation Equipment Manufacturing - Transportation, Logistics, Supply Chain and Storage - Transportation Programs - Transportation/Trucking/Railroad - Travel Arrangements - Truck Transportation - Trusts and Estates - Turned Products and Fastener Manufacturing - Urban Transit Services - Utilities - Utilities Administration - Utility System Construction - Vehicle Repair and Maintenance - Venture Capital and Private Equity Principals - Veterinary - Veterinary Services - Vocational Rehabilitation Services - Warehousing - Warehousing and Storage - Waste Collection - Waste Treatment and Disposal - Water Supply and Irrigation Systems - Water, Waste, Steam, and Air Conditioning Services - Wellness and Fitness Services - Wholesale - Wholesale Alcoholic Beverages - Wholesale Apparel and Sewing Supplies - Wholesale Appliances, Electrical, and Electronics - Wholesale Building Materials - Wholesale Chemical and Allied Products - Wholesale Computer Equipment - Wholesale Drugs and Sundries - Wholesale Food and Beverage - Wholesale Footwear - Wholesale Furniture and Home Furnishings - Wholesale Hardware, Plumbing, Heating Equipment - Wholesale Import and Export - Wholesale Luxury Goods and Jewelry - Wholesale Machinery - Wholesale Metals and Minerals - Wholesale Motor Vehicles and Parts - Wholesale Paper Products - Wholesale Petroleum and Petroleum Products - Wholesale Photography Equipment and Supplies - Wholesale Raw Farm Products - Wholesale Recyclable Materials - Wind Electric Power Generation - Wineries - Wine & Spirits - Wireless Services - Women's Handbag Manufacturing - Wood Product Manufacturing - Writing and Editing - Zoos and Botanical Gardens - type: 'null' required: - viewType - industry id: PrivateClientIndustryTypeDto ClientDomainTypeDto: type: object properties: viewType: type: string enum: - clientDomain domain: anyOf: - type: string - type: 'null' required: - viewType - domain id: PrivateClientDomainTypeDto ClientLinkedinUrlTypeDto: type: object properties: viewType: type: string enum: - clientLinkedinUrl linkedinUrl: anyOf: - type: string - type: 'null' required: - viewType - linkedinUrl id: PrivateClientLinkedinUrlTypeDto ClientSizeTypeDto: type: object properties: viewType: type: string enum: - clientSize size: anyOf: - type: string enum: - 1 employee - 2-10 employees - 11-50 employees - 51-200 employees - 201-500 employees - 501-1,000 employees - 1,001-5,000 employees - 5,001-10,000 employees - 10,001+ employees - type: 'null' required: - viewType - size id: PrivateClientSizeTypeDto ClientStageTypeDto: type: object properties: viewType: type: string enum: - clientStage stage: $ref: '#/components/schemas/ClientStageDto' required: - viewType - stage id: PrivateClientStageTypeDto ClientNextTaskDueTypeDto: type: object properties: viewType: type: string enum: - clientNextTaskDue nextTaskDue: anyOf: - $ref: '#/components/schemas/NextTaskDueDto' - type: 'null' required: - viewType - nextTaskDue id: PrivateClientNextTaskDueTypeDto ClientLocationsTypeDto: type: object properties: viewType: type: string enum: - clientLocations locations: type: array items: $ref: '#/components/schemas/LocationDto' required: - viewType - locations id: PrivateClientLocationsTypeDto CustomAttributeItemDto: type: object properties: attributeDefinitionId: type: string minLength: 1 label: type: string aiFillOngoing: type: boolean aiOverridden: type: boolean isFilledByAI: type: boolean value: $ref: '#/components/schemas/SharedCustomAttributeTypeDto' required: - attributeDefinitionId - label - aiFillOngoing - aiOverridden - isFilledByAI - value id: PrivateCustomAttributeItemDto ClientTaxIdentifierDto: type: object properties: id: type: string description: Unique identifier for the tax identifier country: type: string description: >- Two-letter country code (ISO 3166-1 alpha-2) the tax identifier is registered in value: type: string description: Tax identifier value (e.g. VAT number) required: - id - country - value id: PrivateClientTaxIdentifierDto UserBadgeDto: type: object properties: id: type: string name: type: string avatarUrl: anyOf: - type: string - type: 'null' deactivatedAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - id - name - avatarUrl - deactivatedAt id: PrivateUserBadgeDto ClientStageDto: type: object properties: id: type: string minLength: 1 order: type: number name: type: string colorHex: type: string required: - id - order - name - colorHex id: PrivateClientStageDto NextTaskDueDto: type: object properties: id: type: string minLength: 1 content: type: string dueDate: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - id - content - dueDate id: PrivateNextTaskDueDto LocationDto: type: object properties: street1: anyOf: - type: string - type: 'null' street2: anyOf: - type: string - type: 'null' postalCode: anyOf: - type: string - type: 'null' city: anyOf: - type: string - type: 'null' region: anyOf: - type: string - type: 'null' state: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' rawCityCountry: anyOf: - type: string - type: 'null' latitude: anyOf: - type: number - type: 'null' longitude: anyOf: - type: number - type: 'null' formattedAddress: anyOf: - type: string - type: 'null' type: anyOf: - $ref: '#/components/schemas/LocationType' - type: 'null' required: - street1 - street2 - postalCode - city - region - state - country - rawCityCountry - latitude - longitude - formattedAddress - type id: PrivateLocationDto SharedCustomAttributeTypeDto: oneOf: - $ref: '#/components/schemas/CustomTextTypeDto' - $ref: '#/components/schemas/CustomNumberTypeDto' - $ref: '#/components/schemas/CustomCheckboxTypeDto' - $ref: '#/components/schemas/CustomDateTypeDto' - $ref: '#/components/schemas/CustomTimestampTypeDto' - $ref: '#/components/schemas/CustomRatingTypeDto' - $ref: '#/components/schemas/CustomSelectTypeDto' - $ref: '#/components/schemas/CustomMultiSelectTypeDto' - $ref: '#/components/schemas/CustomCurrencyTypeDto' - $ref: '#/components/schemas/CustomDateRangeTypeDto' - $ref: '#/components/schemas/CustomDurationTypeDto' - $ref: '#/components/schemas/CustomUrlTypeDto' - $ref: '#/components/schemas/CustomEntityTypeDto' - $ref: '#/components/schemas/CustomMultiEntityTypeDto' id: SharedPrivateCustomAttributeTypeDto LocationType: type: string enum: - primary_home - secondary_home - primary_work - headquarters - regional_office id: LocationType CustomTextTypeDto: type: object properties: viewType: type: string enum: - customText text: anyOf: - type: string - type: 'null' required: - viewType - text id: PrivateCustomTextTypeDto CustomNumberTypeDto: type: object properties: viewType: type: string enum: - customNumber number: anyOf: - type: number - type: 'null' required: - viewType - number id: PrivateCustomNumberTypeDto CustomCheckboxTypeDto: type: object properties: viewType: type: string enum: - customCheckbox checked: anyOf: - type: boolean - type: 'null' required: - viewType - checked id: PrivateCustomCheckboxTypeDto CustomDateTypeDto: type: object properties: viewType: type: string enum: - customDate date: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - viewType - date id: PrivateCustomDateTypeDto CustomTimestampTypeDto: type: object properties: viewType: type: string enum: - customTimestamp timestamp: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - viewType - timestamp id: PrivateCustomTimestampTypeDto CustomRatingTypeDto: type: object properties: viewType: type: string enum: - customRating rating: anyOf: - type: number - type: 'null' required: - viewType - rating id: PrivateCustomRatingTypeDto CustomSelectTypeDto: type: object properties: viewType: type: string enum: - customSelect select: anyOf: - type: string - type: 'null' required: - viewType - select id: PrivateCustomSelectTypeDto CustomMultiSelectTypeDto: type: object properties: viewType: type: string enum: - customMultiSelect multiSelect: type: array items: type: string required: - viewType - multiSelect id: PrivateCustomMultiSelectTypeDto CustomCurrencyTypeDto: type: object properties: viewType: type: string enum: - customCurrency monetaryAmount: anyOf: - $ref: '#/components/schemas/MonetaryAmountDto' - type: 'null' required: - viewType - monetaryAmount id: PrivateCustomCurrencyTypeDto CustomDateRangeTypeDto: type: object properties: viewType: type: string enum: - customDateRange dateRange: anyOf: - $ref: '#/components/schemas/DateRangeDto' - type: 'null' required: - viewType - dateRange id: PrivateCustomDateRangeTypeDto CustomDurationTypeDto: type: object properties: viewType: type: string enum: - customDuration duration: anyOf: - type: number - type: 'null' required: - viewType - duration id: PrivateCustomDurationTypeDto CustomUrlTypeDto: type: object properties: viewType: type: string enum: - customUrl url: anyOf: - type: string - type: 'null' required: - viewType - url id: PrivateCustomUrlTypeDto CustomEntityTypeDto: type: object properties: viewType: type: string enum: - customEntity type: type: string enum: - user id: anyOf: - type: string - type: 'null' entity: anyOf: - $ref: '#/components/schemas/UserBadgeDto' - type: 'null' required: - viewType - type - id id: PrivateCustomEntityTypeDto CustomMultiEntityTypeDto: type: object properties: viewType: type: string enum: - customMultiEntity type: type: string enum: - user ids: type: array items: type: string entities: type: array items: $ref: '#/components/schemas/UserBadgeDto' required: - viewType - type - ids id: PrivateCustomMultiEntityTypeDto MonetaryAmountDto: type: object properties: currency: $ref: '#/components/schemas/DmCurrency' amount: type: number required: - currency - amount id: PrivateMonetaryAmountDto DateRangeDto: type: object properties: startDate: $ref: '#/components/schemas/DateISO' endDate: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - startDate - endDate id: PrivateDateRangeDto DmCurrency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTC - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNH - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VES - VND - VUV - WST - XAF - XAG - XAU - XCD - XCG - XDR - XOF - XPD - XPF - XPT - YER - ZAR - ZMW - ZWG - ZWL id: DmCurrency securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard. ````