PUT api/v2/organizations/list

ListOrganization

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Type	Additional information
Name	StringExpressionQueryFilterList	None.
Description	StringExpressionQueryFilterList	None.
LegalPersonKind	RelationalExpressionQueryFilterListOfNullableOfLegalPersonKind	None.
BusinessRegistrationSourceKind	RelationalExpressionQueryFilterListOfNullableOfBusinessRegistrationSourceKind	None.
BusinessRegistrationNumber	StringExpressionQueryFilterList	None.
BusinessRegistrationBranchNumber	StringExpressionQueryFilterList	None.
ElectricalOrganizationKind	RelationalExpressionQueryFilterListOfNullableOfElectricalOrganizationKind	None.
Select	ListOrganizationQuerySelect	Required
Sort	Collection of ListOrganizationQuerySort	Required Default value:
PageNumber	integer (32 bits)	Required Default value: 1
PageSize	integer (32 bits)	Required Default value: 100

Request Formats

application/json

Sample:

{
  "Name": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "Description": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "LegalPersonKind": {
    "Filters": [
      {
        "Value": "NaturalPerson",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      },
      {
        "Value": "NaturalPerson",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      }
    ]
  },
  "BusinessRegistrationSourceKind": {
    "Filters": [
      {
        "Value": "NLKVK",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      },
      {
        "Value": "NLKVK",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      }
    ]
  },
  "BusinessRegistrationNumber": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "BusinessRegistrationBranchNumber": {
    "Filters": [
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      },
      {
        "Value": "sample string 1",
        "ExpressionKind": "Equal"
      }
    ]
  },
  "ElectricalOrganizationKind": {
    "Filters": [
      {
        "Value": "None",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      },
      {
        "Value": "None",
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      }
    ]
  },
  "Select": {
    "Name": true,
    "Description": true,
    "Slogan": true,
    "LegalPersonKind": true,
    "ChamberOfCommerceNumber": true,
    "Email": true,
    "TelephoneNumber": true,
    "Website": true,
    "IBAN": true,
    "BIC": true,
    "VatNumber": true,
    "ElectricalOrganizationKind": true,
    "LogoOrganizationFileId": true,
    "LastActivityDate": true,
    "LastActivityUser": true
  },
  "Sort": [
    "Name",
    "Name"
  ],
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListOrganizationQueryResult

Name	Description	Type	Additional information
Organizations		Collection of ListOrganizationQueryResultOrganization	Required
Count		integer (32 bits)	Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "Organizations": [
    {
      "OrganizationId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Slogan": "sample string 3",
      "LegalPersonKind": "NaturalPerson",
      "ChamberOfCommerceNumber": "sample string 4",
      "Email": "sample string 5",
      "TelephoneNumber": "sample string 6",
      "Website": "sample string 7",
      "IBAN": "sample string 8",
      "BIC": "sample string 9",
      "VatNumber": "sample string 10",
      "LastActivityDate": "2025-04-16T15:42:31.506+00:00",
      "LastActivityUser": {
        "UserId": "00000000-0000-0000-0000-000000000000",
        "Email": "sample string 1",
        "DisplayName": "sample string 2"
      },
      "ElectricalOrganizationKinds": [
        "None",
        "None"
      ],
      "LogoOrganizationFileId": "00000000-0000-0000-0000-000000000000"
    },
    {
      "OrganizationId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Slogan": "sample string 3",
      "LegalPersonKind": "NaturalPerson",
      "ChamberOfCommerceNumber": "sample string 4",
      "Email": "sample string 5",
      "TelephoneNumber": "sample string 6",
      "Website": "sample string 7",
      "IBAN": "sample string 8",
      "BIC": "sample string 9",
      "VatNumber": "sample string 10",
      "LastActivityDate": "2025-04-16T15:42:31.506+00:00",
      "LastActivityUser": {
        "UserId": "00000000-0000-0000-0000-000000000000",
        "Email": "sample string 1",
        "DisplayName": "sample string 2"
      },
      "ElectricalOrganizationKinds": [
        "None",
        "None"
      ],
      "LogoOrganizationFileId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "Count": 1
}