Pending proposed edits to this article.
Authentication
Bearer token (content:read): A workspace API key: ud_live_…
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Article id or slug. |
start_cursor | query | string | next_cursor from the previous page. | |
page_size | query | integer | ||
bot_id | query | string | Only for a key that covers several bots (see GET /bots). Or send the Usedocs-Bot header. |
Responses
| Status | Description |
|---|---|
200 | Pending edits. |
400 | The request is missing something or has a bad value. |
401 | No API key, or the key is revoked. |
403 | A read key on a write, or a key for another bot. |
404 | Not found. |
429 | Rate limited: 120 requests a minute per key, 30 tasks an hour. See Retry-After. |
Response fields
| Field | Type | Description |
|---|---|---|
results | Draft[] | |
has_more | boolean | |
next_cursor | `string | null` |
results[]: Draft
| Field | Type | Description |
|---|---|---|
id | string | edit_…, article_…, or gap_… |
type | string | One of: edit, new_article, gap_draft. |
articleId | `string | null` |
title | string | |
source | string | One of: code, customers, requests, import, translations. |
detail | string | |
reason | string | |
conflict | boolean | The article changed after the edit was proposed. |
live | boolean | The edited article is published. |
originUrl | `string | null` |
createdAt | string (date-time) |