Skip to main content
GET
/
supply-chains
/
companies
/
{hashid}
/
cURL
curl --request GET \
  --url http://localhost:3000/connect/v1/supply-chains/companies/{hashid}/ \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "currency": {
    "id": "<string>",
    "name": "<string>",
    "code": "<string>"
  },
  "buyer": {
    "id": "<string>",
    "name": "<string>",
    "entity_card": {
      "id": "<string>",
      "card": {
        "id": "<string>",
        "card_id": "<string>",
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "display_id": "<string>",
        "creator": "<string>",
        "updater": "<string>"
      },
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "is_active": true,
      "creator": "<string>",
      "updater": "<string>",
      "entity": "<string>"
    },
    "image": "<string>",
    "description": "<string>"
  },
  "entity_card": {
    "id": "<string>",
    "card": {
      "id": "<string>",
      "card_id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "display_id": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    },
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>",
    "entity": "<string>"
  },
  "forms": [
    {
      "id": "<string>",
      "products": [
        {
          "id": "<string>",
          "premiums": "<string>",
          "is_active": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "description": "<string>",
          "image": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "fields": [
        {
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label": "<string>",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "type": "TEXT",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "field_config": [
        {
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label": "<string>",
          "key": "<string>",
          "visibility": true,
          "required": true,
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "form_type": "TRANSACTION",
      "creator": "<string>",
      "updater": "<string>",
      "owner": "<string>"
    }
  ],
  "field_visibilties": [
    {
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "visibility": true,
      "type": "TRANSACTION",
      "creator": "<string>",
      "updater": "<string>",
      "company": "<string>"
    }
  ],
  "owned_premiums": [
    "<string>"
  ],
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "image": "<string>",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "name": "<string>",
  "buy_enabled": true,
  "sell_enabled": true,
  "quality_correction": true,
  "allow_multiple_login": true,
  "creator": "<string>",
  "updater": "<string>",
  "members": [
    "<string>"
  ],
  "products": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
hashid
string
required

Response

200 - application/json
​
name
string
required

Name of the company.

Required string length: 1 - 500
​
id
string

Unique identifier for the company.

​
currency
object

The currency used by the company for financial transactions.

​
buyer
object

The buyer entity associated with the company.

​
entity_card
object

Information related to the entity card of the company.

​
forms
object[]

Forms associated with the company.

​
field_visibilties
object[]

Field visibilities configured for the company.

​
owned_premiums
string[]

Premiums owned by the company.

​
updated_on
string<date-time>

Date and time when the company information was last updated.

​
created_on
string<date-time>

Date and time when the company was created.

​
image
string<uri> | null

URL to the photo or logo of the company.

​
description
string | null

Description or additional information about the company.

Maximum length: 500
​
house_name
string | null

Name of the house or building where the company is located.

Maximum length: 100
​
street
string | null

Name of the street where the company is located.

Maximum length: 500
​
city
string | null

Name of the city where the company is located.

Maximum length: 500
​
sub_province
string | null

Name of the sub-province where the company is located.

Maximum length: 500
​
province
string | null

Name of the province where the company is located.

Maximum length: 500
​
latitude
number

Latitude coordinate of the company's location.

​
longitude
number

Longitude coordinate of the company's location.

​
zipcode
string | null

Postal code or ZIP code of the area where the company is located.

Maximum length: 50
​
country
string | null

Name of the country where the company is located.

Maximum length: 500
​
email
string<email> | null

Email address of the company.

Maximum length: 100
​
phone
string | null

Phone number of the company.

Maximum length: 50
​
buy_enabled
boolean

Indicates whether buying functionality is enabled for the company.

​
sell_enabled
boolean

Indicates whether selling functionality is enabled for the company.

​
quality_correction
boolean

Indicates whether quality correction is enabled for the company.

​
allow_multiple_login
boolean

Indicates whether multiple logins are allowed for the company.

​
creator
string

Identifier of the user who created the company.

​
updater
string

Identifier of the user who last updated the company.

​
members
string[]

Members associated with the company.

​
products
string[]

Products associated with the company.