GET api/OrgApi

No documentation available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "SaveId": "24cf3d2b-04a8-419d-aa61-2543ad80f166",
    "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-08-04T21:55:18.6985568+00:00",
    "LastActivity": "2026-08-04T21:55:18.6985568+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": "10017c67-9ae0-4f9d-b3c5-03c152a231a6",
          "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": "d70bdaeb-f7b1-4f5e-9ca5-9f3158bdf08c",
          "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": "375ea46f-9dab-4b1d-9047-d6d372f167f8",
          "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": "aa891240-9098-40d6-a68f-6fb85a585090",
          "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-08-04T21:55:18.6985568+00:00",
          "UserName": "sample string 6",
          "Message": "sample string 7",
          "ContactId": "34a9ab6b-8101-405f-b12c-8b646d59ecd2",
          "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": "f2c14037-b9b8-4cc4-b122-a38f2a26060a",
          "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": "91e4ce4e-612c-4426-bd53-5b34ba0ec551",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "16"
        },
        {
          "$ref": "16"
        }
      ]
    },
    "BankDetail": {
      "$id": "17",
      "AccountId": "d82fc3de-e1f4-4804-a9c6-d5101b9d4df6",
      "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": "ccb18696-a509-477f-9ac6-4c9274255fd8",
      "IsLicence": true,
      "LicenceNo": "sample string 3",
      "LicenceExpiryDate": "sample string 4",
      "Contact": {
        "$ref": "2"
      },
      "IsDeleted": true
    },
    "FinancialArrangement": {
      "$id": "19",
      "FinancialId": "b4b703c9-edb7-4803-8dcf-c2fb82e229ad",
      "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": "89926009-adec-4a66-8f97-54b71cfc7804",
      "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": "24778073-ac80-4b75-8d97-dbc60a3ea148",
      "EmailForQuote": "sample string 2",
      "IsLogisticQuote": true,
      "IsLogisticFirm": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "Category": {
      "$id": "22",
      "CategoryId": "7d6be982-1585-40c2-b52b-43d451eb9275",
      "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": "486b960d-2d16-4fbc-b8a2-d2f187f164f0",
          "ContactSaveId": "654cd1f0-2165-4a98-9a9e-dd3f79b4beac",
          "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": "9e5d99d9-9ae0-44c2-8b57-b7c81b253924",
      "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": "7f8e087d-dd41-43aa-a139-8ffc7e81cc46",
            "ContactMethod": {
              "$ref": "25"
            },
            "IsDeleted": true
          },
          {
            "$ref": "27"
          },
          {
            "$ref": "27"
          }
        ]
      },
      "Contact": {
        "$ref": "2"
      }
    },
    "BuyingCriteria": {
      "$id": "28",
      "CriteriaId": "95d8646d-479b-4593-ae7a-b728243d75cf",
      "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": "4b11f4d9-89f7-4f9f-828c-3906516f3ef6",
      "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": "30f241ae-f89d-45cc-8e49-14ea0c23fec3",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "31"
          },
          {
            "$ref": "31"
          }
        ]
      },
      "Suppliers": {
        "$id": "32",
        "$values": [
          {
            "$id": "33",
            "Id": 1,
            "SupplierName": "sample string 2",
            "SaleId": "b63dc83d-8275-4393-ba25-166d45113b92",
            "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-08-04T21:55:18.6985568+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": "70c3c483-2cc7-4966-bab6-a563b883e694",
          "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-08-04T21:55:18.6985568+00:00",
          "EndDate": "2026-08-04T21:55:18.6985568+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": "0ab3266b-085c-45b3-bd68-8429332c932f",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "37"
        },
        {
          "$ref": "37"
        }
      ]
    },
    "CreatedTimestamp": "2026-08-04T21:55:18.6985568+00:00",
    "IsClient": true,
    "RpsStatus": "sample string 21",
    "RpsUpdatedDate": "2026-08-04T21:55:18.6985568+00:00",
    "PersonalInformation": {
      "$id": "38",
      "PersonalId": "1dff26fb-6397-4b7e-b7b0-4f10e50d5a25",
      "Gender": "sample string 1",
      "DateOfBirth": "2026-08-04T21:55:18.6985568+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": "e18770c8-62e8-4fa6-aebc-e60826531ed8",
    "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-08-04T21:55:18.6985568+00:00",
    "OrganisationId": "sample string 35",
    "Main": true,
    "WBSBookingId": "309be3a2-df85-4996-b77c-3b8bc1e218c8",
    "WBSFirmSaveId": "e53e2a0a-602d-4a69-9493-820bd7ba2da1",
    "WBSDriverSaveId": "b97220ab-0154-44a7-b82c-b988a405f778",
    "WBSUserId": "cb8de0f1-416b-4c0e-9337-520660c8e1df",
    "WBSUserSaveId": "e1ab9d86-8152-4c54-b4f7-3e3203af77d0"
  },
  {
    "$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.