Skip to main content

OrganizationDetail

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
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
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"]
createdAtdate-timerequired

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
updatedAtdate-timerequired

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
onboardingStatusstringrequired

Current onboarding status of the organization

Possible values: <= 20 characters

Example: New
customFieldsobjectrequired

Key-value pairs for organization-specific data fields

Example: {"factoryCode":"GTX001"}
contacts object[]required

List of primary contact persons for the organization

  • Array [
    • firstNamestringrequired

    First name of the contact person

    Possible values: <= 100 characters

    Example: Minh
    lastNamestring

    Last name of the contact person

    Possible values: <= 100 characters

    Example: Tran
    emailemailrequired

    Email address of the contact person

    Possible values: <= 255 characters

    phoneNumberstring

    Phone number of the contact person

    Possible values: <= 50 characters

    Example: +84 912 345 678
    rolestring

    Job title or role of the contact person within the organization, can refer from List Contact Roles API

    Possible values: <= 100 characters

    Example: Factory Manager
  • ]
    • location objectrequired

    Location coordinates of the organization

    longitudenumber

    Longitude of the organization's location

    Example: 121.4737
    latitudenumber

    Latitude of the organization's location

    Example: 31.2304
    OrganizationDetail
    {
      "id": 1269,
      "externalId": "S-123",
      "name": "Acme Corp",
      "type": "S",
      "capabilities": [
        "Dyeing",
        "Knitting",
        "Cut & Sew"
      ],
      "phoneNumber": "1505111222",
      "externalStatus": "active",
      "address": "5 Madison Avenue",
      "city": "New York",
      "province": "New York",
      "postalCode": "A1B2C3",
      "country": "US",
      "maleEmployees": 100,
      "femaleEmployees": 100,
      "permissions": [
        "edit"
      ],
      "createdAt": "2024-09-01T08:30:00Z",
      "updatedAt": "2025-06-10T13:45:00Z",
      "inspId": "acme-corp",
      "onboardingStatus": "New",
      "customFields": {
        "factoryCode": "GTX001"
      },
      "contacts": [
        {
          "firstName": "Minh",
          "lastName": "Tran",
          "email": "[email protected]",
          "phoneNumber": "+84 912 345 678",
          "role": "Factory Manager"
        }
      ],
      "location": {
        "longitude": 121.4737,
        "latitude": 31.2304
      }
    }