SubOrganization

idintegerrequired

Internal unique identifier of the sub-organization (system-generated)

Example: 5472

externalIdstringrequired

The identifier assigned by the API consumer

Possible values: <= 255 characters

Example: New-Sub-ORG-ID

namestringrequired

Official name of the sub-organization

Possible values: <= 255 characters

Example: ABCGH

externalStatusstringrequired

Sub-organization status as defined by the external system or API consumer

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

Example: active

countrystringrequired

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

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

Example: AF

citystring | nullnullablerequired

The city where the sub-organization is located

Possible values: <= 100 characters

Example:

provincestring | nullnullablerequired

The province or state where the sub-organization is located

Possible values: <= 100 characters

Example:

postalCodestring | nullnullablerequired

Postal or ZIP code of the sub-organization's address

Possible values: <= 20 characters

Example:

maleEmployeesintegerrequired

Number of male employees reported by the sub-organization

Example: 123456

femaleEmployeesintegerrequired

Number of female employees reported by the sub-organization

Example: 1241

solutionsUsedstring[]required

List of solutions used by the sub-organization

Possible values: [Inspection, T&A, Lab Test]

Example: ["Inspection","T&A","Lab Test"]

phoneNumberstring | nullnullablerequired

The phone number of the sub-organization

Possible values: <= 50 characters

Example:

updatedAtstring<date-time>required

Timestamp when the sub-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-12-18T09:51:32Z

linkedOrganizations object[]required

List of organizations linked to this sub-organization

Array [

idintegerrequired

Internal unique identifier of the linked organization

Example: 5484

namestringrequired

Name of the linked organization

Possible values: <= 255 characters

Example: Test Local Org link to sub org 9897970123

]

SubOrganization

{
  "id": 5472,
  "externalId": "New-Sub-ORG-ID",
  "name": "ABCGH",
  "externalStatus": "active",
  "country": "AF",
  "city": "",
  "province": "",
  "postalCode": "",
  "maleEmployees": 123456,
  "femaleEmployees": 1241,
  "solutionsUsed": [
    "Inspection",
    "T&A",
    "Lab Test"
  ],
  "phoneNumber": "",
  "updatedAt": "2025-12-18T09:51:32Z",
  "linkedOrganizations": [
    {
      "id": 5484,
      "name": "Test Local Org 1"
    },
    {
      "id": 5189,
      "name": "Test Local Org 2"
    },
    {
      "id": 5203,
      "name": "Test Local Org 3"
    }
  ]
}