> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fairfood.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Company Details Endpoint

> Get Company Details endpoint allows you to retrieve detailed information about a specific company within the supply chain by making a GET request. Provide the hash ID of the company in the endpoint URL.



## OpenAPI

````yaml get /supply-chains/companies/{hashid}/
openapi: 3.0.1
info:
  title: Trace Connect API
  version: v1
servers:
  - url: http://localhost:3000/connect/v1
security:
  - Bearer: []
paths:
  /supply-chains/companies/{hashid}/:
    get:
      tags:
        - supply-chains
      description: A viewset for viewing and editing Company instances.
      operationId: supply-chains_companies_read
      parameters:
        - name: hashid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
components:
  schemas:
    Company:
      required:
        - name
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the company.
        currency:
          $ref: '#/components/schemas/Currency'
          description: The currency used by the company for financial transactions.
        buyer:
          $ref: '#/components/schemas/Entity'
          description: The buyer entity associated with the company.
        entity_card:
          $ref: '#/components/schemas/EntityCard'
          description: Information related to the entity card of the company.
        forms:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Form'
          description: Forms associated with the company.
        field_visibilties:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/CompanyFieldVisibiltySerilizer'
          description: Field visibilities configured for the company.
        owned_premiums:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
          description: Premiums owned by the company.
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
          description: Date and time when the company information was last updated.
        created_on:
          title: Created On
          type: string
          format: date-time
          description: Date and time when the company was created.
        image:
          title: Photo
          type: string
          format: uri
          nullable: true
          readOnly: true
          description: URL to the photo or logo of the company.
        description:
          title: Description
          maxLength: 500
          type: string
          nullable: true
          description: Description or additional information about the company.
        house_name:
          title: House name
          maxLength: 100
          type: string
          nullable: true
          description: Name of the house or building where the company is located.
        street:
          title: Street
          maxLength: 500
          type: string
          nullable: true
          description: Name of the street where the company is located.
        city:
          title: City
          maxLength: 500
          type: string
          nullable: true
          description: Name of the city where the company is located.
        sub_province:
          title: Sub province
          maxLength: 500
          type: string
          nullable: true
          description: Name of the sub-province where the company is located.
        province:
          title: Province
          maxLength: 500
          type: string
          nullable: true
          description: Name of the province where the company is located.
        latitude:
          title: Latitude
          type: number
          description: Latitude coordinate of the company's location.
        longitude:
          title: Longitude
          type: number
          description: Longitude coordinate of the company's location.
        zipcode:
          title: Zipcode
          maxLength: 50
          type: string
          nullable: true
          description: Postal code or ZIP code of the area where the company is located.
        country:
          title: Country
          maxLength: 500
          type: string
          nullable: true
          description: Name of the country where the company is located.
        email:
          title: Email Address
          maxLength: 100
          type: string
          format: email
          nullable: true
          description: Email address of the company.
        phone:
          title: Phone Number
          maxLength: 50
          type: string
          nullable: true
          description: Phone number of the company.
        name:
          title: Company Name
          maxLength: 500
          minLength: 1
          type: string
          description: Name of the company.
        buy_enabled:
          title: Buy Enabled
          type: boolean
          description: Indicates whether buying functionality is enabled for the company.
        sell_enabled:
          title: Sell Enabled
          type: boolean
          description: Indicates whether selling functionality is enabled for the company.
        quality_correction:
          title: Quality Correction
          type: boolean
          description: Indicates whether quality correction is enabled for the company.
        allow_multiple_login:
          title: Allow Multiple Login
          type: boolean
          description: Indicates whether multiple logins are allowed for the company.
        creator:
          type: string
          description: Identifier of the user who created the company.
        updater:
          type: string
          description: Identifier of the user who last updated the company.
        members:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
          description: Members associated with the company.
        products:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
          description: Products associated with the company.
    Currency:
      required:
        - name
      type: object
      properties:
        id:
          type: string
        name:
          title: Currency Name
          maxLength: 1000
          minLength: 1
          type: string
        code:
          title: Currency Code
          maxLength: 100
          type: string
          nullable: true
    Entity:
      type: object
      properties:
        id:
          type: string
        name:
          title: Name
          minLength: 1
          type: string
          readOnly: true
        entity_card:
          $ref: '#/components/schemas/EntityCard'
        image:
          title: Photo
          type: string
          format: uri
          nullable: true
          readOnly: true
        description:
          title: Description
          maxLength: 500
          type: string
          nullable: true
    EntityCard:
      required:
        - card
        - entity
      type: object
      properties:
        id:
          type: string
        card:
          $ref: '#/components/schemas/ConnectCard'
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        created_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        is_active:
          title: Is Active
          type: boolean
          readOnly: true
        creator:
          type: string
        updater:
          type: string
        entity:
          type: string
    Form:
      required:
        - fields
        - owner
      type: object
      properties:
        id:
          type: string
        products:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Product'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FormField'
        field_config:
          type: array
          items:
            $ref: '#/components/schemas/FormFieldConfig'
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        created_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        form_type:
          title: Form Type
          type: string
          enum:
            - TRANSACTION
            - FARMER
            - PAYMENT
            - PRODUCT
        creator:
          type: string
        updater:
          type: string
        owner:
          type: string
    CompanyFieldVisibiltySerilizer:
      required:
        - company
        - name
      type: object
      properties:
        id:
          type: string
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        created_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        name:
          title: Name
          maxLength: 100
          minLength: 1
          type: string
        visibility:
          title: Visibility
          type: boolean
        type:
          title: Type
          type: string
          enum:
            - TRANSACTION
            - FARMER
        creator:
          type: string
        updater:
          type: string
        company:
          type: string
    ConnectCard:
      required:
        - card_id
      type: object
      properties:
        id:
          type: string
        card_id:
          title: Card id
          minLength: 1
          type: string
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        created_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        display_id:
          title: Display ID
          maxLength: 100
          type: string
          nullable: true
        creator:
          type: string
        updater:
          type: string
    Product:
      required:
        - name
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the product.
        premiums:
          title: Premiums
          type: string
          readOnly: true
          description: Premiums associated with the product.
        is_active:
          title: Is active
          type: string
          readOnly: true
          description: Indicates whether the product is currently active.
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
          description: Date and time when the product information was last updated.
        created_on:
          title: Created On
          type: string
          format: date-time
          readOnly: true
          description: Date and time when the product was created.
        name:
          title: Product Name
          maxLength: 500
          minLength: 1
          type: string
          description: Name of the product.
        description:
          title: Product Description
          maxLength: 500
          type: string
          nullable: true
          description: Description of the product.
        image:
          title: Product Image
          type: string
          format: uri
          nullable: true
          readOnly: true
          description: URL to the image or photo of the product.
        creator:
          type: string
          description: Identifier of the user who created the product.
        updater:
          type: string
          description: Identifier of the user who last updated the product.
    FormField:
      required:
        - label
        - type
      type: object
      properties:
        id:
          type: string
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        created_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        label:
          title: Label
          maxLength: 100
          minLength: 1
          type: string
        label_en_us:
          title: Label [en-us]
          maxLength: 100
          type: string
          nullable: true
        label_en_uk:
          title: Label [en-uk]
          maxLength: 100
          type: string
          nullable: true
        label_fr:
          title: Label [fr]
          maxLength: 100
          type: string
          nullable: true
        label_nl:
          title: Label [nl]
          maxLength: 100
          type: string
          nullable: true
        label_ind:
          title: Label [ind]
          maxLength: 100
          type: string
          nullable: true
        type:
          title: Field Type
          type: string
          enum:
            - TEXT
            - INTEGER
            - FLOAT
            - RADIO
            - MULTI_SELECT
            - EMAIL
            - PHONE
            - DATE
            - BOOLEAN
            - DROPDOWN
        key:
          title: Key
          maxLength: 100
          type: string
          nullable: true
        required:
          title: Required
          type: boolean
        default_value:
          title: Default Value
          maxLength: 100
          type: string
          nullable: true
        options:
          title: Options
          type: string
          nullable: true
        creator:
          type: string
        updater:
          type: string
    FormFieldConfig:
      required:
        - key
        - label
      type: object
      properties:
        id:
          type: string
        updated_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        created_on:
          title: Updated On
          type: string
          format: date-time
          readOnly: true
        label:
          title: Label
          maxLength: 100
          minLength: 1
          type: string
        key:
          title: Key
          maxLength: 100
          minLength: 1
          type: string
        visibility:
          title: Visibility
          type: boolean
        required:
          title: Required
          type: boolean
        creator:
          type: string
        updater:
          type: string
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header

````