ListLegalEntity
GET/orgs/:org_guid/legal-entities
ListLegalEntity
Request
Path Parameters
Query Parameters
Possible values: non-empty
and <= 64 characters
Поиск производится по полям: juridical_name, juridical_address, inn, kpp, ogrn, meta, metadata
Possible values: [created_at_asc
, created_at_desc
, updated_at_asc
, updated_at_desc
, juridical_name_asc
, juridical_name_desc
]
Possible values: [alive_only
, archived_only
, all
]
Possible values: [compact
, full
]
Header Parameters
ClientIdentifier
Possible values: [Unknown
, App
, WebApp
, Service
]
ClientType
ClientName
ClientOSName
ClientOSVersion
ClientScreenResolution
ClientModel
OrganizationAlias
ClientExtensions
Language
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
items
object[]
nullable
items
Possible values: >= 2 characters
and <= 256 characters
juridical_name
Possible values: >= 2 characters
and <= 256 characters
juridical_address
Possible values: non-empty
inn
Possible values: [Osn
, Usn
, UsnMinus
, Envd
, Esn
, Patent
], >= 1
tax_systems
Possible values: >= 9 characters
and <= 9 characters
, Value must match regular expression ^\d+$
kpp
ogrn
organization
object
guid
type_of
crpt_token
created_at
updated_at
deleted_at
Possible values: <= 128 characters
meta
meta_data
object
nullable
meta_data
guid
type_of
next_page_token
page_number
pages_total
items_per_page
items_total
type_of
{
"items": [
{
"juridical_name": "string",
"juridical_address": "string",
"inn": "string",
"tax_systems": [
"Osn"
],
"kpp": "string",
"ogrn": "string",
"organization": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "string"
},
"crpt_token": "string",
"created_at": "2024-11-18T08:30:46.426Z",
"updated_at": "2024-11-18T08:30:46.426Z",
"deleted_at": "2024-11-18T08:30:46.426Z",
"meta": "string",
"meta_data": {},
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "string"
}
],
"next_page_token": "string",
"page_number": 0,
"pages_total": 0,
"items_per_page": 0,
"items_total": 0,
"type_of": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Client Error
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Server Error
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}