Skip to main content

Получить список организаций

GET 
/v5/orgs

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции

Важная информация!​

Поиск по списку производится по полям: "name" и "alias".

Request​

Query Parameters

    created_from date-time
    created_to date-time
    updated_from date-time
    updated_to date-time
    query string

    Possible values: non-empty and <= 64 characters

    Поиск производится по полям: name, alias, meta, metadata

    order_by OrganizationOrderings

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, name_asc, name_desc]

    page_token string
    selection SelectionModes

    Possible values: [alive_only, archived_only, all]

    presentation PresentationModes

    Possible values: [compact, full]

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: 014fb8f7-fcb5-4c84-8b22-7348a549ccc8
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Responses​

Success

Schema

    items

    object[]

    nullable

  • Array [

    • name stringrequired

    Possible values: >= 2 characters and <= 24 characters

    alias stringrequired

    Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

    owner

    object

    guid uuid
    type_of stringnullable

    support

    object

    line stringrequired

    Possible values: >= 2 characters and <= 24 characters

    responsibility stringrequired

    Possible values: >= 2 characters and <= 128 characters

    phone stringnullable

    Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

    email stringnullable

    Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

    opening_hours stringnullable

    Possible values: >= 2 characters and <= 128 characters

    whatsapp stringnullable

    Possible values: >= 2 characters and <= 64 characters

    viber stringnullable

    Possible values: >= 2 characters and <= 64 characters

    telegram stringnullable

    Possible values: >= 2 characters and <= 64 characters

    type_of stringnullable

    extensions

    OrganizationExtensions

    Расширения

    notification_service

    object

    turned_on booleanrequired
    primary_url_for_notifications urirequired
    secondary_url_for_notifications urinullable
    version stringrequired

    Possible values: non-empty and <= 8 characters

    lifepay_auth

    object

    signature stringrequired

    Possible values: >= 8 characters and <= 128 characters

    version stringrequired

    Possible values: non-empty and <= 8 characters

    created_at date-time
    updated_at date-time
    deleted_at date-timenullable
    meta stringnullable

    Possible values: <= 128 characters

    meta_data

    object

    nullable

    property name* string
    guid uuid
    type_of stringnullable

  • ]

    • next_page_token stringnullable
    page_number int32
    pages_total int32
    items_per_page int32
    items_total int32
    type_of stringnullable
Loading...