GET api/v2/organizations/list

ListOrganization

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Body Parameters

None.

Response Information

Resource Description

ListOrganizationQueryResult

ListOrganizationQueryResult
NameDescriptionTypeAdditional 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
}