Skip to main content

Organization

idintegerrequired

Internal unique identifier of the organization (system-generated)

Example: 1269
externalIdstringrequired

The identifier assigned by the API consumer

Possible values: <= 255 characters

Example: S-123
namestringrequired

Official name of the organization

Possible values: <= 255 characters

Example: Acme Corp
typestringrequired

Classification of the organization. Support F(Factory), S(Supplier), B(Brand), R(Retailer), I(Inspection Agency)

Possible values: [F, S, B, R, I]

Example: S
capabilitiesstring[]required

List of capabilities or services the organization offers, can refer from List Capabilities API

Possible values: <= 255 characters

Example: ["Dyeing","Knitting","Cut & Sew"]
phoneNumberstringrequired

The phone number of the organization

Possible values: <= 50 characters

Example: 1505111222
externalStatusstringrequired

Organization status as defined by the external system or API consumer

Possible values: [active, inactive, awaiting approval, draft, suspended, blacklisted, closed]

Example: active
businessPartnerTypesstring[]

Classification of the supplier organization's role in the supply chain. Multiple values allowed and configured by customer taxonomy (Custom ID field).

Example: ["fabric supplier","trim supplier"]
brandTypesstring[]

Indicates whether the supplier owns brands, works with national brands, or both. Values configured by customer taxonomy (Custom ID field).

Example: ["owned brand"]
addressstringrequired

The street address of the organization

Possible values: <= 500 characters

Example: 5 Madison Avenue
citystringrequired

The city where the organization is located

Possible values: <= 100 characters

Example: New York
provincestringrequired

The province or state where the organization is located

Possible values: <= 100 characters

Example: New York
postalCodestringrequired

Postal or ZIP code of the organization's address

Possible values: <= 20 characters

Example: A1B2C3
countrystringrequired

Country where the organization is located (ISO 3166-1 alpha-2 format recommended)

Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: US
maleEmployeesinteger | nullnullablerequired

Number of male employees reported by the organization

Example: 100
femaleEmployeesinteger | nullnullablerequired

Number of female employees reported by the organization

Example: 100
relationshipsCountintegerrequired

Number of relationships this organization has

Example: 0
permissionsstring[]required

Indicates the access level of the current user has for the listed organization. This helps determine what actions the user can perform (e.g., view-only, edit, manage relationships)

Possible values: [read, write, edit, share, full]

Example: ["edit"]
createdAtstring<date-time>required

Timestamp when the organization record was created (ISO 8601 format)

Possible values: Value must match regular expression ^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(\.\d{3})?Z$

Example: 2024-09-01T08:30:00Z
updatedAtstring<date-time>required

Timestamp when the organization record was last updated (ISO 8601 format)

Possible values: Value must match regular expression ^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(\.\d{3})?Z$

Example: 2025-06-10T13:45:00Z
inspIdstringrequired

The customizable internal identifier is shown in the URL and visible to users

Possible values: <= 10 characters

Example: acme-corp
invitationStatusstringrequired

Current invitation status of the organization

Possible values: <= 20 characters

Example: New
location object

Location coordinates of the organization

longitudenumber<double>

Longitude of the organization's location

Example: 121.4737
latitudenumber<double>

Latitude of the organization's location

Example: 31.2304
webLinksstring[]

List of official website/social network URLs for the organization. Each entry must be a valid URL

Example: ["https://www.linkedin.com/company/abc-supplier","https://facebook.com/abc-supplier"]
yearEstablishedinteger

Year the organization was founded

Example: 1998
legalBusinessNamestring

Registered name of the organization

Possible values: <= 255 characters

Example: ABC Textiles Co., Ltd.
subsidiariesstring[]

List of subsidiaries under the same corporate group

Possible values: <= 255 characters

Example: ["ABC Vietnam Ltd.","ABC Bangladesh Co., Ltd."]
targetMarketSegmentsstring[]

Key customer/product segments served

Possible values: <= 255 characters

Example: ["Mass Market","Luxury Only"]
industrySegmentsstring[]

Industry vertical(s) the organization operates in.

Possible values: [Apparel & Textiles, Footwear, Beauty & Personal Care & Hygiene, Food & Beverage, Consumer Electronics, Home Appliances & Electrical, Furniture & Home Decorations, Houseware, Sports Equipment & Outdoors, Toys & Games, Stationery & Print & Packaging, Home Improvement & Building, Pet Care & Food, Arts & Crafts & Entertainment, Other]

Example: ["Apparel & Textiles","Food & Beverage"]
geographicMarketsServedstring[]

Primary markets or regions where the organization operates

Possible values: [North America, Europe, Asia-Pacific, Global]

Example: ["Asia-Pacific","Europe"]
primaryLanguagesstring[]

Main languages used for communication, use set 1 from List of ISO 639 language codes

Possible values: <= 2 characters, Value must match regular expression ^[a-z]{2}$

Example: ["en","vi"]
timeZonesstring[]

Time zones of operation, from List of tz database time zones

Possible values: <= 100 characters

Example: ["America/Fort_Nelson","Asia/Singapore"]
nearestAirportsstring[]

List of nearest commercial airports to the organization. Accepts IATA 3-letter airport codes. Max 200 characters total.

Possible values: <= 200 characters

Example: ["SGN","HAN","BKK"]
nearestSeaportsstring[]

List of nearest maritime seaports near the organization. Accepts UN/LOCODE 5-character port codes. Max 200 characters total.

Possible values: <= 200 characters

Example: ["VNSGN","THBKK"]
tierLevelsstring[]

Tier Level indicates the organization's position within the supply chain hierarchy.

Possible values: [Tier 1, Tier 2, Tier 3, Tier 4, Tier 5+]

Example: ["Tier 2"]
labelsstring[]

A list of custom labels to categorize or group organizations for internal management and filtering purposes (e.g., Preferred Supplier, Vendor, Strategic Partner).

Example: ["Preferred Supplier","Strategic Partner"]
customFieldsobjectrequired

Key-value pairs for organization-specific data fields

Example: {"factoryCode":"GTX001"}
businessUnitCategoriesstring[]

High-level grouping of business activities for the organization. Multiple values allowed and configured by customer taxonomy (Custom ID field).

Example: ["businessUnitCategory1","businessUnitCategory2"]
businessUnitsstring[]

Defines the operational unit(s) within the organization. Multiple values allowed and configured by customer taxonomy (Custom ID field).

Example: ["businessUnit1","businessUnit2"]
linkedSubOrgs object[]

Sub-organizations (Office/Division) linked to this organization

  • Array [
    • idstringrequired

    Internal identifier of the linked sub-organization, returned as a string

    Example: 5484
    namestringrequired

    Name of the linked sub-organization

    Possible values: <= 255 characters

    Example: Alpha Office
  • ]
    • relationshipTypesstring[]

    Relationship types of this organization's active relationships, aggregated from both directions. Where the organization is the target of a relationship, the reverse name of the type is used.

    Possible values: <= 255 characters

    Example: ["customer","direct supplier"]
    declaredBy object[]

    Supplier Profile(s) of the organization(s) that declared this organization.

  • Array [
    • idintegerrequired

    Internal identifier of the Supplier Profile that declared this organization

    Example: 4401
    namestringrequired

    Name of the declaring organization

    Possible values: <= 255 characters

    Example: Acme Sourcing
  • ]
    • declaredTo object[]

    Network Profile(s) of the organization(s) to whom this organization was declared.

  • Array [
    • idintegerrequired

    Internal identifier of the Network Profile the organization was declared to

    Example: 8801
    namestringrequired

    Name of the organization the declaration was made to

    Possible values: <= 255 characters

    Example: Global Brand Ltd
  • ]
    • lastDeclaredOn(string | null)<date-time>nullable

    Timestamp in UTC indicating when the organization was last declared. This value is updated on re-declaration. Null if the organization has never been declared.

    Possible values: Value must match regular expression ^\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\dZ$

    Example: 2025-03-15T09:00:00Z
    Organization
    {
      "id": 1269,
      "externalId": "S-123",
      "name": "Acme Corp",
      "type": "S",
      "capabilities": [
        "Dyeing",
        "Knitting",
        "Cut & Sew"
      ],
      "phoneNumber": "1505111222",
      "externalStatus": "active",
      "businessPartnerTypes": [
        "fabric supplier",
        "trim supplier"
      ],
      "brandTypes": [
        "owned brand"
      ],
      "address": "5 Madison Avenue",
      "city": "New York",
      "province": "New York",
      "postalCode": "A1B2C3",
      "country": "US",
      "maleEmployees": 100,
      "femaleEmployees": 100,
      "relationshipsCount": 0,
      "permissions": [
        "edit"
      ],
      "createdAt": "2024-09-01T08:30:00Z",
      "updatedAt": "2025-06-10T13:45:00Z",
      "inspId": "acme-corp",
      "invitationStatus": "New",
      "location": {
        "longitude": 121.4737,
        "latitude": 31.2304
      },
      "webLinks": [
        "https://www.linkedin.com/company/abc-supplier",
        "https://facebook.com/abc-supplier"
      ],
      "yearEstablished": 1998,
      "legalBusinessName": "ABC Textiles Co., Ltd.",
      "subsidiaries": [
        "ABC Vietnam Ltd.",
        "ABC Bangladesh Co., Ltd."
      ],
      "targetMarketSegments": [
        "Mass Market",
        "Luxury Only"
      ],
      "industrySegments": [
        "Apparel & Textiles",
        "Food & Beverage"
      ],
      "geographicMarketsServed": [
        "Asia-Pacific",
        "Europe"
      ],
      "primaryLanguages": [
        "en",
        "vi"
      ],
      "timeZones": [
        "America/Fort_Nelson",
        "Asia/Singapore"
      ],
      "nearestAirports": [
        "SGN",
        "HAN",
        "BKK"
      ],
      "nearestSeaports": [
        "VNSGN",
        "THBKK"
      ],
      "tierLevels": [
        "Tier 2"
      ],
      "labels": [
        "Preferred Supplier",
        "Strategic Partner"
      ],
      "customFields": {
        "factoryCode": "GTX001"
      },
      "businessUnitCategories": [
        "businessUnitCategory1",
        "businessUnitCategory2"
      ],
      "businessUnits": [
        "businessUnit1",
        "businessUnit2"
      ],
      "linkedSubOrgs": [
        {
          "id": "5484",
          "name": "Alpha Office"
        }
      ],
      "relationshipTypes": [
        "customer",
        "direct supplier"
      ],
      "declaredBy": [
        {
          "id": 4401,
          "name": "Acme Sourcing"
        }
      ],
      "declaredTo": [
        {
          "id": 8801,
          "name": "Global Brand Ltd"
        }
      ],
      "lastDeclaredOn": "2025-03-15T09:00:00Z"
    }