GET api/OrgApi

No documentation available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "SaveId": "18323191-fe1a-4d5c-9dcd-1a8e800c08e0",
    "TenantId": "sample string 2",
    "EdgeTenantId": "sample string 3",
    "EdgeCompanyName": "sample string 4",
    "ContactSignature": "sample string 5",
    "UserId": "sample string 6",
    "ContactSource": "sample string 7",
    "UserName": "sample string 8",
    "Status": "sample string 9",
    "PreferredTradeCurrency": "sample string 10",
    "MaxCreditLimit": 11.1,
    "CreditCurrency": "sample string 12",
    "DueTimeTill": 13,
    "KnownSince": "2026-05-06T12:50:17.2866782+00:00",
    "LastActivity": "2026-05-06T12:50:17.2866782+00:00",
    "XeroShortCode": "sample string 14",
    "Image": "sample string 15",
    "Categories": "sample string 16",
    "CreditRating": "sample string 17",
    "Grade": "sample string 18",
    "Phone": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "Id": 1,
          "PhoneNo": "sample string 2",
          "PhoneExt": "sample string 3",
          "PhoneType": "sample string 4",
          "ContactId": "8172405e-6727-4cef-80da-c70c48ae9a17",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    "SocialChannel": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "Id": 1,
          "ContactChannel": "sample string 2",
          "ChannelType": "sample string 3",
          "ContactId": "b3a1e5df-9160-4636-a302-60533c7d4fa6",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ]
    },
    "Website": {
      "$id": "7",
      "$values": [
        {
          "$id": "8",
          "Id": 1,
          "WebName": "sample string 2",
          "WebType": "sample string 3",
          "ContactId": "bb01f533-d765-4720-a98b-01bafed269b9",
          "IsDeleted": true,
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "Email": {
      "$id": "9",
      "$values": [
        {
          "$id": "10",
          "Id": 1,
          "ContactEmail": "sample string 2",
          "EmailType": "sample string 3",
          "ContactId": "1835d985-4dfa-4a03-b2c0-66a378f217cc",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "10"
        },
        {
          "$ref": "10"
        }
      ]
    },
    "Note": {
      "$id": "11",
      "$values": [
        {
          "$id": "12",
          "Id": 1,
          "UserId": "sample string 2",
          "Activity": "sample string 3",
          "Detail": "sample string 4",
          "CreatdTimestamp": "2026-05-06T12:50:17.2866782+00:00",
          "UserName": "sample string 6",
          "Message": "sample string 7",
          "ContactId": "3d04edc2-d80b-4a5d-9754-ec0daaccc8d3",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "12"
        },
        {
          "$ref": "12"
        }
      ]
    },
    "Address": {
      "$id": "13",
      "$values": [
        {
          "$id": "14",
          "AddressId": 1,
          "CountryName": "sample string 2",
          "AddressType": "sample string 3",
          "AddressLine1": "sample string 4",
          "AddressLine2": "sample string 5",
          "TownLocality": "sample string 6",
          "CityRegion": "sample string 7",
          "PostalZipCode": "sample string 8",
          "State": "sample string 9",
          "INState": "sample string 10",
          "MXState": "sample string 11",
          "BRState": "sample string 12",
          "CAState": "sample string 13",
          "SiteName": "sample string 14",
          "IsMain": true,
          "ContactId": "9cdd6392-70a4-4298-b7ae-23bf1643ae59",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        }
      ]
    },
    "Carrier": {
      "$id": "15",
      "$values": [
        {
          "$id": "16",
          "CarrierId": 1,
          "LogisticCompany": "sample string 2",
          "AccountNumber": "sample string 3",
          "TaxNumber": "sample string 4",
          "TaxType": "sample string 5",
          "IsMain": true,
          "ContactId": "ee168602-b25c-4d76-b782-1c5a28a08ee1",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "16"
        },
        {
          "$ref": "16"
        }
      ]
    },
    "BankDetail": {
      "$id": "17",
      "AccountId": "65a4170b-deee-4178-b9f7-d612b5d106b7",
      "AccountName": "sample string 2",
      "AccountNo": "sample string 3",
      "SortCode": "sample string 4",
      "BankIBAN": "sample string 5",
      "BankSwift": "sample string 6",
      "Contact": {
        "$ref": "2"
      }
    },
    "ControlsLicence": {
      "$id": "18",
      "ControlsLicenceId": "af8d4da7-9b19-4e6e-b703-61f0ef34035b",
      "IsLicence": true,
      "LicenceNo": "sample string 3",
      "LicenceExpiryDate": "sample string 4",
      "Contact": {
        "$ref": "2"
      },
      "IsDeleted": true
    },
    "FinancialArrangement": {
      "$id": "19",
      "FinancialId": "74732ca5-8cd6-4119-842d-af8108916bf4",
      "PaymentTerm": "sample string 2",
      "PaymentTermValue": "sample string 3",
      "PaymentMethod": "sample string 4",
      "PaymentMethodValue": "sample string 5",
      "Discount": 6.1,
      "Commission": 7.1,
      "BankAccountName": "sample string 8",
      "BankAccountNumber": "sample string 9",
      "BankSortCode": "sample string 10",
      "SaleTaxRegistration": "sample string 11",
      "SaleTax": "sample string 12",
      "CompanyRegistrationNumber": "sample string 13",
      "CustomerAccNo": "sample string 14",
      "EoriNumber": "sample string 15",
      "Contact": {
        "$ref": "2"
      }
    },
    "Supplier": {
      "$id": "20",
      "Id": "330011fa-af19-4fc2-835e-cd7fadaf8b56",
      "AccountNo": "sample string 2",
      "SupplierId": "sample string 3",
      "NormalLeadTime": 4.0,
      "ActualLeadTime": 5.0,
      "OrderQuantity": 6.0,
      "OrderValue": 7.0,
      "CallOff": 8.0,
      "IsSupplier": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "Logistic": {
      "$id": "21",
      "Id": "0543dbec-47f7-4559-bcd1-c92e750ec580",
      "EmailForQuote": "sample string 2",
      "IsLogisticQuote": true,
      "IsLogisticFirm": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "Category": {
      "$id": "22",
      "CategoryId": "9ddacde2-1c20-4560-921a-673b342a4918",
      "IsAgent": true,
      "IsConsultant": true,
      "IsCustomer": true,
      "IsDistributor": true,
      "IsFinancer": true,
      "IsFreightForwarder": true,
      "IsInsurer": true,
      "IsReferrer": true,
      "IsManufacturer": true,
      "IsFriend": true,
      "IsProcessor": true,
      "IsStaff": true,
      "IsOther": true,
      "IsConsignor": true,
      "IsSupplier": true,
      "IsInstaller": true,
      "IsDriver": true,
      "IsSubContractor": true,
      "Miscellaneous": "sample string 20",
      "IsRetailer": true,
      "IsSeller": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "ContactFiles": {
      "$id": "23",
      "$values": [
        {
          "$id": "24",
          "ContactFileId": "f26bdd1f-b9e0-4a5d-b21d-179d5b26603d",
          "ContactSaveId": "7bbcc801-a9c0-4e84-8e6d-a5f4d1801763",
          "SpecificationType": "sample string 3",
          "FileName": "sample string 4",
          "DocType": "sample string 5",
          "WhenAttached": "sample string 6",
          "ValidTillDateTime": "sample string 7",
          "NoOfPages": "sample string 8",
          "FileData": "sample string 9",
          "FilePath": "sample string 10",
          "Comments": "sample string 11",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "24"
        },
        {
          "$ref": "24"
        }
      ]
    },
    "ContactMethod": {
      "$id": "25",
      "ContactMethodId": "cd6d1254-2ce5-4b27-95db-442649e21657",
      "LinkedIn": "sample string 2",
      "Twitter": "sample string 3",
      "FaceBook": "sample string 4",
      "IM": {
        "$id": "26",
        "$values": [
          {
            "$id": "27",
            "Id": 1,
            "Message": "sample string 2",
            "IMType": "sample string 3",
            "ContactMethodId": "59a60992-195f-464a-97fd-3abf363a2218",
            "ContactMethod": {
              "$ref": "25"
            },
            "IsDeleted": true
          },
          {
            "$ref": "27"
          },
          {
            "$ref": "27"
          }
        ]
      },
      "Contact": {
        "$ref": "2"
      }
    },
    "BuyingCriteria": {
      "$id": "28",
      "CriteriaId": "408a7bd5-778a-4b80-9864-092a3d446de9",
      "AuthoriseToBuy": "sample string 2",
      "Period": "sample string 3",
      "Method": "sample string 4",
      "Power": "sample string 5",
      "Expectation": "sample string 6",
      "Need": "sample string 7",
      "Contact": {
        "$ref": "2"
      }
    },
    "SaleApproach": {
      "$id": "29",
      "Id": "e6d1bb95-87ea-443e-8a0a-a25e05144183",
      "GiveDiscounts": "sample string 2",
      "ContactEvery": "sample string 3",
      "EmailMarketing": "sample string 4",
      "CurrentSupplier": "sample string 5",
      "Competitor": "sample string 6",
      "Competitors": {
        "$id": "30",
        "$values": [
          {
            "$id": "31",
            "Id": 1,
            "CompetitorName": "sample string 2",
            "SaleId": "e0c97967-8375-4873-b08b-63def08e93bc",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "31"
          },
          {
            "$ref": "31"
          }
        ]
      },
      "Suppliers": {
        "$id": "32",
        "$values": [
          {
            "$id": "33",
            "Id": 1,
            "SupplierName": "sample string 2",
            "SaleId": "4001c808-82d1-46cb-aed4-0a276c91ef0e",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "33"
          },
          {
            "$ref": "33"
          }
        ]
      },
      "OurRelationship": "sample string 7",
      "RelationshipMgr": "sample string 8",
      "Contact": {
        "$ref": "2"
      }
    },
    "AppendNotes": {
      "$id": "34",
      "$values": [
        {
          "$id": "35",
          "AppendNoteId": 1,
          "CreatedDate": "2026-05-06T12:50:17.2866782+00:00",
          "CreatedBy": "sample string 3",
          "ActivityNote": "sample string 4",
          "AppendNote": "sample string 5",
          "Subject": "sample string 6",
          "ContactName": "sample string 7",
          "ContactMethod": "sample string 8",
          "Location": "sample string 9",
          "ChildAppendNotes": "sample string 10",
          "ContactId": "83dbb929-d717-4476-b8ae-992e01bbc0ed",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "35"
        },
        {
          "$ref": "35"
        }
      ]
    },
    "Event": {
      "$id": "36",
      "$values": [
        {
          "$id": "37",
          "EventId": 1,
          "Subject": "sample string 2",
          "EventType": "sample string 3",
          "AssignTo": "sample string 4",
          "StartDate": "2026-05-06T12:50:17.2866782+00:00",
          "EndDate": "2026-05-06T12:50:17.2866782+00:00",
          "IsAllDayEvent": "sample string 7",
          "ContactName": "sample string 8",
          "ContactEmail": "sample string 9",
          "ContactMethod": "sample string 10",
          "Location": "sample string 11",
          "Status": "sample string 12",
          "IsCalendarEvent": "sample string 13",
          "Note": "sample string 14",
          "SenderComapny": "sample string 15",
          "SenderEmail": "sample string 16",
          "MainEventId": 17,
          "ContactId": "cd6b7b6c-441f-4cab-87be-519e58ff57ab",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "37"
        },
        {
          "$ref": "37"
        }
      ]
    },
    "CreatedTimestamp": "2026-05-06T12:50:17.2866782+00:00",
    "IsClient": true,
    "RpsStatus": "sample string 21",
    "RpsUpdatedDate": "2026-05-06T12:50:17.2866782+00:00",
    "PersonalInformation": {
      "$id": "38",
      "PersonalId": "ea795315-8e71-41cd-8f6a-d23c52833b92",
      "Gender": "sample string 1",
      "DateOfBirth": "2026-05-06T12:50:17.2866782+00:00",
      "NotifyBirthday": "sample string 2",
      "Occupation": "sample string 3",
      "MaritalStatus": "sample string 4",
      "PersonalStatus": "sample string 5",
      "Interests": "sample string 6",
      "NationalInsuranceNo": "sample string 7",
      "Contact": {
        "$ref": "2"
      }
    },
    "MinExpiryDays": 22,
    "CountryList": {
      "$id": "39",
      "$values": [
        {
          "$id": "40",
          "Id": 1,
          "CountryCode": "sample string 2",
          "Name": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "$ref": "40"
        },
        {
          "$ref": "40"
        }
      ]
    },
    "XeroId": "0c14478d-c054-45af-aa96-627f2db2de88",
    "OwingAmount": 24.1,
    "OwingCcy": "sample string 25",
    "FreeAgentId": "sample string 26",
    "QuickBookId": "sample string 27",
    "QuickBookSupplierId": "sample string 28",
    "SageOneId": "sample string 29",
    "ShopifyId": "sample string 30",
    "BigCommerceId": "sample string 31",
    "FaireId": "sample string 32",
    "WooCommerceId": "sample string 33",
    "UpdatedDateTimeStamp": "2026-05-06T12:50:17.2866782+00:00",
    "OrganisationId": "sample string 35",
    "Main": true,
    "WBSBookingId": "ae4e72a1-50fb-4942-9a36-534ffc953b6f",
    "WBSFirmSaveId": "23157acd-8b3b-4046-ba74-065397948827",
    "WBSDriverSaveId": "52f8bad8-b649-40eb-9551-2d547e0d1358",
    "WBSUserId": "584ca290-349b-4835-8ed8-0e009a96520f",
    "WBSUserSaveId": "ad0ada49-6f01-4306-8901-b2888fcf702b"
  },
  {
    "$ref": "2"
  },
  {
    "$ref": "2"
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: One or more errors occurred.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: One or more errors occurred.