Search organizations

GET /api/search
Searches for organizations by partial name or TIN.

🔐Authentication

Query parameters

FieldType/FormatRequiredDescriptionExample
searchstring<3 to 100 characters>Search string: partial organization name or full TIN9731062087, Столичный

Request example

GET /api/search?search=9731062087

Response

ParameterType/FormatRequiredDescriptionExample
idstring<uuid>Unique organization identifier452f081a-7612-48e1-bc4e-89d6cea366e7
organizationstringOrganization nameООО УК "Столичный дом"
categoriesstringService categories, comma-separatedКвартплата,Водоснабжение, Электроснабжение
tinstringOrganization TIN (Tax Identification Number)7712345678
bankAccountstringOrganization bank account40702810500000001234

Response example

json
{ "data": [ { "id": "452f081a-7612-48e1-bc4e-89d6cea366e7", "organization": "ООО УК \"Столичный дом\"", "categories": "Квартплата", "tin": "7712345678", "bankAccount": "40702810500000001234" } ] }

Error Codes

Error CodeHTTP StatusMessageCauseSolution
VALIDATION_FAILED400Invalid format of inputParameter validation errorCheck the search format
ORGANIZATION_NOT_FOUND404Organization is not foundOrganization not foundRefine your search query
INTERNAL_SERVER_ERROR500Internal server errorInternal server errorTry again later or contact support