RelationshipListResponse

Response containing list of relationships

data object[]required

Array of relationships associated with the specified organization

Array [

target object

The organization at the other end of the relationship

idintegerrequired

Internal ID of the organization

Example: 1122

externalIdstring | nullnullablerequired

External ID of the organization, as provided by the API consumer

Possible values: <= 255 characters

Example: F1111

typestringrequired

Type of the organization.

F: Factory
S: Supplier
R: Retailer
B: Brand
I: Inspection Agency

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

Example: F

namestringrequired

Display name of the organization

Possible values: <= 255 characters

Example: Local Factory 111

inspIdstring | nullnullablerequired

System identifier used in application URLs (nullable)

Possible values: <= 10 characters

Example: null

leadSupplier object

The designated lead supplier for this relationship, if defined

anyOf

RelationshipOrganization
null

idintegerrequired

Internal ID of the organization

Example: 1122

externalIdstring | nullnullablerequired

External ID of the organization, as provided by the API consumer

Possible values: <= 255 characters

Example: F1111

typestringrequired

Type of the organization.

F: Factory
S: Supplier
R: Retailer
B: Brand
I: Inspection Agency

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

Example: F

namestringrequired

Display name of the organization

Possible values: <= 255 characters

Example: Local Factory 111

inspIdstring | nullnullablerequired

System identifier used in application URLs (nullable)

Possible values: <= 10 characters

Example: null

typestringrequired

The relationship type between the organizations is defined by the customer. Refer to the List Relationship Types endpoint to retrieve the full list of supported values.

Possible values: <= 255 characters

Example: contract manufacturer

customFieldsobjectrequired

Key-value pairs for any custom data linked to the relationship

Example: {"custom1":"2025-01-01"}

permissionsstring[]required

List of permissions granted to the user for managing or viewing this relationship

Possible values: [read, edit, full, share, relationship-read, relationship-edit, request-onboard]

Example: ["edit","full","read"]

]

RelationshipListResponse
{
  "data": [
    {
      "target": {
        "id": 1122,
        "externalId": "F1111",
        "type": "F",
        "name": "Local Factory 111",
        "inspId": null
      },
      "leadSupplier": {
        "id": 1122,
        "externalId": "F1111",
        "type": "F",
        "name": "Local Factory 111",
        "inspId": null
      },
      "type": "contract manufacturer",
      "customFields": {
        "custom1": "2025-01-01"
      },
      "permissions": [
        "edit",
        "full",
        "read"
      ]
    }
  ]
}