# Show Loyalty Club

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/management/loyalty_club:
    get:
      summary: Show Loyalty Club
      deprecated: false
      description: ''
      tags:
        - API Reference/Management API/Core/Loyalty Clubs
      parameters:
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  loyalty_club:
                    $ref: '#/components/schemas/Loyalty%20Club'
                x-apidog-orders:
                  - loyalty_club
                required:
                  - loyalty_club
                x-apidog-ignore-properties: []
              example:
                loyalty_club:
                  id: 1
                  name: quibusdam cum error
                  description:
                    en: Text
                  phone_number: '+14155552671'
                  email: somebody@example.com
                  region: aute ut reprehenderit voluptate
                  city: Methuen Town
                  zip_code: 53422-7572
                  address: adipisicing eu
                  latitude: -73.9874
                  longitude: -73.9874
                  opening_hours:
                    - type: day
                      period: '2025-05-15'
                      hours: null
                      description:
                        en: Closed
                    - type: weekday
                      period: sunday
                      hours:
                        opens_at: '12:00'
                        closes_at: '15:00'
                      description:
                        en: Text
                  social_profiles:
                    facebook: https://example.com
                    twitter: https://example.com
                    instagram: https://example.com
                    linkedin: https://example.com
                    snapchat: https://example.com
                    tiktok: https://example.com
                    youtube: https://example.com
                    pinterest: https://example.com
                  dmp_token: ex nostrud et cupidatat sunt
                  internal_options: {}
                  languages:
                    - in nulla velit laboris deserunt
                  minimum_member_age: 18
                  shortening_tracking_enabled: false
                  timezone: Europe/Warsaw
                  transactions_currency: PLN
                  community_id: 1
                  customer_id: 447
                  everyone_audience_id: 1
                  created_at: '2022-11-05T16:25:58.099Z'
                  updated_at: '2022-11-15T16:25:58.099Z'
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Management API/Core/Loyalty Clubs
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3913523-run
components:
  schemas:
    Loyalty Club:
      type: object
      properties:
        id: &ref_4
          $ref: '#/components/schemas/id'
          description: Primary identifier of the record
          readOnly: true
        created_at: &ref_5
          type: string
          description: Time at which the record was created
          format: date-time
          readOnly: true
          examples:
            - '2022-11-15T16:25:58.099512Z'
        updated_at: &ref_6
          type: string
          description: Time at which the record was updated for the last time
          format: date-time
          readOnly: true
          examples:
            - '2022-11-15T16:25:58.099512Z'
        customer_id: &ref_3
          $ref: '#/components/schemas/id.customer_id'
          description: Customer the record is assigned to
        name:
          type: string
          description: Public name of the Loyalty Club
        description: &ref_2
          $ref: '#/components/schemas/LocalizedContent'
        phone_number:
          anyOf:
            - $ref: '#/components/schemas/phone_number'
            - type: 'null'
        email:
          anyOf:
            - $ref: '#/components/schemas/email'
            - type: 'null'
        region:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        zip_code:
          type: string
          nullable: true
        address:
          type: string
          nullable: true
        latitude:
          anyOf:
            - &ref_0
              $ref: '#/components/schemas/coordinate_value'
            - type: 'null'
        longitude:
          anyOf:
            - *ref_0
            - type: 'null'
        opening_hours:
          anyOf:
            - $ref: '#/components/schemas/OpeningHoursList'
            - type: 'null'
        social_profiles:
          $ref: '#/components/schemas/cms.social_profiles'
        dmp_token:
          type: string
          readOnly: true
        internal_options:
          type: object
          properties: {}
          x-apidog-orders: []
          description: Object containing options specific to the particular Loyalty Club
          readOnly: true
          x-apidog-ignore-properties: []
        languages:
          type: array
          items:
            $ref: '#/components/schemas/language'
          readOnly: true
        minimum_member_age:
          type: integer
          minimum: 1
          examples:
            - 18
          readOnly: true
        shortening_tracking_enabled:
          type: boolean
          readOnly: true
        timezone:
          $ref: '#/components/schemas/timezone'
        transactions_currency:
          $ref: '#/components/schemas/currency'
        community_id:
          $ref: '#/components/schemas/id.community_id'
        everyone_audience_id:
          type: integer
          readOnly: true
          examples:
            - 1
          format: uint64
          description: ID of the audience that contains all members of Loyalty Club
      required:
        - id
        - created_at
        - updated_at
        - customer_id
        - name
        - description
        - phone_number
        - email
        - region
        - city
        - zip_code
        - address
        - latitude
        - longitude
        - opening_hours
        - social_profiles
        - dmp_token
        - internal_options
        - languages
        - minimum_member_age
        - shortening_tracking_enabled
        - timezone
        - transactions_currency
        - community_id
        - everyone_audience_id
      x-apidog-orders:
        - 01K4MEVC5CESHSKVWB588TM9BX
        - 01K4MF57Q8DAXD5E037V6HGX56
        - name
        - description
        - phone_number
        - email
        - region
        - city
        - zip_code
        - address
        - latitude
        - longitude
        - opening_hours
        - social_profiles
        - dmp_token
        - internal_options
        - languages
        - minimum_member_age
        - shortening_tracking_enabled
        - timezone
        - transactions_currency
        - community_id
        - everyone_audience_id
      x-apidog-refs:
        01K4MEVC5CESHSKVWB588TM9BX:
          $ref: '#/components/schemas/Base%20record%20attributes'
        01K4MF57Q8DAXD5E037V6HGX56:
          $ref: '#/components/schemas/customer_id'
      x-apidog-ignore-properties:
        - id
        - created_at
        - updated_at
        - customer_id
      x-apidog-folder: ''
    id.community_id:
      type: integer
      description: ID of the Loyalty Club community that the record is assigned to
      format: uint64
      examples:
        - 1
      readOnly: true
      x-apidog-folder: ''
    currency:
      type: string
      description: ISO 4217 currency
      examples:
        - PLN
        - NOK
      x-apidog-folder: ''
    timezone:
      type: string
      examples:
        - Europe/Warsaw
        - Europe/Oslo
      description: ISO 8601 timezone
      x-apidog-folder: ''
    language:
      type: string
      description: 'See: [Supported language tags](doc-341959#suported-language-tags)'
      x-apidog-folder: ''
    cms.social_profiles:
      type: object
      properties:
        facebook: &ref_1
          $ref: '#/components/schemas/url'
        twitter: *ref_1
        instagram: *ref_1
        linkedin: *ref_1
        snapchat: *ref_1
        tiktok: *ref_1
        youtube: *ref_1
        pinterest: *ref_1
      x-apidog-orders:
        - facebook
        - twitter
        - instagram
        - linkedin
        - snapchat
        - tiktok
        - youtube
        - pinterest
      description: 'URLs on specific social media '
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    url:
      type: string
      examples:
        - https://example.com
      x-apidog-folder: ''
    OpeningHoursList:
      type: array
      items:
        $ref: '#/components/schemas/OpeningHoursItem'
      description: 'See: [Opening Hours](doc-342133)'
      x-apidog-folder: ''
    OpeningHoursItem:
      type: object
      examples:
        - type: weekday
          period: monday
          hours:
            opens_at: '09:00'
            closes_at: '18:00'
          description:
            en: Text
        - type: weekday
          period: sunday
          hours:
            opens_at: '12:00'
            closes_at: '15:00'
          description:
            en: Text
        - type: day
          period: '2025-05-15'
          hours: null
          description:
            en: Closed
      properties:
        type:
          type: string
          examples:
            - weekday
          const: weekday
        period:
          anyOf:
            - description: 'For type: "day"'
              $ref: '#/components/schemas/date'
            - type: string
              enum:
                - monday
                - tuesday
                - wednesday
                - thursday
                - friday
                - saturday
                - sunday
              x-apidog-enum:
                - value: monday
                  name: ''
                  description: ''
                - value: tuesday
                  name: ''
                  description: ''
                - value: wednesday
                  name: ''
                  description: ''
                - value: thursday
                  name: ''
                  description: ''
                - value: friday
                  name: ''
                  description: ''
                - value: saturday
                  name: ''
                  description: ''
                - value: sunday
                  name: ''
                  description: ''
              description: 'For type: "weekday"'
        hours:
          type: object
          properties:
            opens_at:
              type: string
              description: Hour of entity opening time
              examples:
                - '09:00'
              pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
            closes_at:
              type: string
              description: |
                Hour of entity closing time
              examples:
                - '15:00'
              pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
          x-apidog-orders:
            - opens_at
            - closes_at
          required:
            - opens_at
            - closes_at
          description: When null, object is closed at this period
          x-apidog-ignore-properties: []
          nullable: true
        description: *ref_2
      x-apidog-orders:
        - type
        - period
        - hours
        - description
      readOnly: true
      required:
        - type
        - period
        - hours
      x-apidog-refs: {}
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date:
      type: string
      format: date
      examples:
        - '2023-01-15'
      x-apidog-folder: ''
    coordinate_value:
      type: number
      title: ''
      description: >-
        Single geographic coordinate (float). Use -90..90 for latitude or
        -180..180 for longitude.
      $id: https://example.com/schemas/coordinate_value.json
      minimum: -180
      maximum: 180
      examples:
        - 12.345678
        - -73.9874
      x-apidog-folder: ''
    email:
      type: string
      format: email
      examples:
        - somebody@example.com
      x-apidog-folder: ''
    phone_number:
      type: string
      title: ''
      description: Phone number in E.164 format. Up to 15 digits. No spaces or separators.
      $id: https://example.com/schemas/phone_number.json
      pattern: ^\+?[1-9]\d{1,14}$
      examples:
        - '+14155552671'
        - '46701234567'
      x-apidog-folder: ''
    LocalizedContent:
      type: object
      properties: {}
      x-apidog-orders: []
      title: ''
      examples:
        - en: Text
      additionalProperties:
        type: string
        description: >-
          The actual set of languages depends on LC configuration. See:
          [Localization](doc-341959)
        examples:
          - Tekst
        nullable: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    id.customer_id:
      type: integer
      format: uint64
      readOnly: true
      examples:
        - 447
      description: Customer the record is assigned to
      x-apidog-folder: ''
    id:
      type: integer
      description: Primary identifier of the record
      format: uint64
      readOnly: true
      examples:
        - 1
      x-apidog-folder: ''
    customer_id:
      type: object
      properties:
        customer_id: *ref_3
      x-apidog-orders:
        - customer_id
      required:
        - customer_id
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Base record attributes:
      type: object
      properties:
        id: *ref_4
        created_at: *ref_5
        updated_at: *ref_6
      x-apidog-orders:
        - id
        - created_at
        - updated_at
      required:
        - id
        - created_at
        - updated_at
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```