Получение списка новостей

Возвращает список новостей с пагинацией и фильтрацией по статусу.

Request

GET

https://api.kit.yandex.net/v1/blogs

Query parameters

Name

Description

status

Type: BlogStatus[]

Статус новости.

Example: ``

page

Type: integer

Номер страницы.

Default: 1

Min value: 1

per_page

Type: integer

Количество элементов на странице.

Default: 25

Min value: 1

Max value: 100

BlogStatus

Статус публикации новости.

Type: string

Enum: ACTIVE, INACTIVE

Responses

200 OK

Список новостей.

Body

application/json
{
  "blogs": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "slug": "example",
      "title": "example",
      "short_description": "example",
      "is_short_description_auto_generated": true,
      "content": "example",
      "blog_dates": {
        "start_date": "2025-01-01T00:00:00Z",
        "end_date": "2025-01-01T00:00:00Z"
      },
      "tags": [
        "example"
      ],
      "seo_title": "example",
      "seo_h1": "example",
      "seo_description": "example",
      "desktop_media": [
        {
          "type": "IMAGE",
          "display_sequence": 1,
          "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
          "video_id": "abc123xyz"
        }
      ],
      "mobile_media": [
        null
      ],
      "preview_media": [
        null
      ],
      "attachment": {
        "type": "CATEGORY",
        "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
      },
      "status": "ACTIVE"
    }
  ],
  "total_count": 0
}

Name

Description

blogs

Type: Blog[]

Example
[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "slug": "example",
    "title": "example",
    "short_description": "example",
    "is_short_description_auto_generated": true,
    "content": "example",
    "blog_dates": {
      "start_date": "2025-01-01T00:00:00Z",
      "end_date": "2025-01-01T00:00:00Z"
    },
    "tags": [
      "example"
    ],
    "seo_title": "example",
    "seo_h1": "example",
    "seo_description": "example",
    "desktop_media": [
      {
        "type": "IMAGE",
        "display_sequence": 1,
        "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
        "video_id": "abc123xyz"
      }
    ],
    "mobile_media": [
      null
    ],
    "preview_media": [
      null
    ],
    "attachment": {
      "type": "CATEGORY",
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    },
    "status": "ACTIVE"
  }
]

total_count

Type: integer

Общее количество новостей по текущему фильтру.

BlogID

Идентификатор новости.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

BlogDates

Даты действия новости.

Name

Description

start_date

Type: string<date-time>

Дата публикации новости.

Example: 2025-01-01T00:00:00Z

end_date

Type: string<date-time>

Example: 2025-01-01T00:00:00Z
Example
{
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-01-01T00:00:00Z"
}

FileType

Тип файла.

Type: string

Enum: IMAGE, VIDEO, OTHER

FileID

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

Type: string<uuid>

Example: 019b30d4-3e28-7a98-ae46-cb66932d1936

VariantMedia

Медиафайлы товара (изображения и видео).

Name

Description

display_sequence

Type: integer

Порядок отображения.

type

Type: FileType

Тип файла.

Enum: IMAGE, VIDEO, OTHER

image_id

Type: FileID

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

Example: 019b30d4-3e28-7a98-ae46-cb66932d1936

video_id

Type: string

Идентификатор видео (для VIDEO).

Example: abc123xyz
Example
{
  "type": "IMAGE",
  "display_sequence": 1,
  "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
  "video_id": "abc123xyz"
}

BlogAttachmentType

Тип сущности привязанной к новости (категория или коллекция). К новости можно привязать только одну сущность.

Type: string

Enum: CATEGORY, COLLECTION

CategoryID

Идентификатор категории.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

CollectionID

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

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

BlogAttachment

Name

Description

id
One of 2 types

  • Type: CategoryID

    Идентификатор категории.

    Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

  • Type: CollectionID

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

    Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

Идентификатор сущности привязанной к новости.

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

type

Type: BlogAttachmentType

Тип сущности привязанной к новости (категория или коллекция). К новости можно привязать только одну сущность.

Enum: CATEGORY, COLLECTION
Example
{
  "type": "CATEGORY",
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
}

Blog

Name

Description

blog_dates

Type: BlogDates

Даты действия новости.

Example
{
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-01-01T00:00:00Z"
}

content

Type: string

Содержимое новости.

Example: example

id

Type: BlogID

Идентификатор новости.

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

seo_description

Type: string

SEO описание новости.

Example: example

seo_h1

Type: string

SEO H1 новости.

Example: example

seo_title

Type: string

SEO заголовок новости.

Example: example

slug

Type: string

URL-идентификатор новости.

Example: example

status

Type: BlogStatus

Статус новости.

Статус публикации новости.

Enum: ACTIVE, INACTIVE

tags

Type: string[]

Теги новости.

Example
[
  "example"
]

title

Type: string

Заголовок новости.

Example: example

attachment

Type: BlogAttachment

Связанная сущность.

Example
{
  "type": "CATEGORY",
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
}

desktop_media

Type: VariantMedia[]

Медиа для отображения на версии для компьютера.

Example
[
  {
    "type": "IMAGE",
    "display_sequence": 1,
    "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
    "video_id": "abc123xyz"
  }
]

is_short_description_auto_generated

Type: boolean

Флаг, указывающий, что краткое описание было сгенерировано автоматически.

mobile_media

Type: VariantMedia[]

Медиа для отображения на мобильном устройстве.

Example
[
  {
    "type": "IMAGE",
    "display_sequence": 1,
    "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
    "video_id": "abc123xyz"
  }
]

preview_media

Type: VariantMedia[]

Медиа для отображения в превью.

Example
[
  {
    "type": "IMAGE",
    "display_sequence": 1,
    "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
    "video_id": "abc123xyz"
  }
]

short_description

Type: string

Краткое описание.

Example: example
Example
{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "slug": "example",
  "title": "example",
  "short_description": "example",
  "is_short_description_auto_generated": true,
  "content": "example",
  "blog_dates": {
    "start_date": "2025-01-01T00:00:00Z",
    "end_date": "2025-01-01T00:00:00Z"
  },
  "tags": [
    "example"
  ],
  "seo_title": "example",
  "seo_h1": "example",
  "seo_description": "example",
  "desktop_media": [
    {
      "type": "IMAGE",
      "display_sequence": 1,
      "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
      "video_id": "abc123xyz"
    }
  ],
  "mobile_media": [
    null
  ],
  "preview_media": [
    null
  ],
  "attachment": {
    "type": "CATEGORY",
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  },
  "status": "ACTIVE"
}

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

401 Unauthorized

Не авторизован.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000
Предыдущая
Обновление новости
Следующая
Создание новости