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

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: <= 20 characters

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

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

tiersstring[]required

List of tiers the organization belongs to

Example: []

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

sharedTostring[]required

A list of organization IDs this organization is shared with

Example: ["org-789","org-456"]

customFieldsobjectrequired

Key-value pairs for organization-specific data fields

Example: {"factoryCode":"GTX001"}

Organization

{
  "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,
  "relationshipsCount": 0,
  "permissions": [
    "edit"
  ],
  "tiers": [],
  "createdAt": "2024-09-01T08:30:00Z",
  "updatedAt": "2025-06-10T13:45:00Z",
  "inspId": "acme-corp",
  "onboardingStatus": "New",
  "sharedTo": [
    "org-789",
    "org-456"
  ],
  "customFields": {
    "factoryCode": "GTX001"
  }
}