DocumentService

List Documents

Returns documents visible to the key owner in the registry, newest first by default, filtered by status, type, initiator, creation date, and last change. List items carry the document’s scalar fields only — files and route are omitted; call GetDocument for those. Note: a document reachable only through a participant grant (you are a signer but neither the initiator nor a permission holder) is returned by GetDocument but does not appear here — the registry lists by initiator and permission scope.

Required scope: documents:read

Error Codes:

DEVELOPER.SCOPE_INSUFFICIENT: The key lacks the documents:read scope.
INVALID_ARGUMENT: A malformed page_token or date.

GET

developer

documents

List Documents

curl --request GET \
  --url https://app.doodocs.kz/api/developer/v1/documents \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.doodocs.kz/api/developer/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.doodocs.kz/api/developer/v1/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.doodocs.kz/api/developer/v1/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.doodocs.kz/api/developer/v1/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "documents": [
    {
      "completed_at": "2023-11-07T05:31:56Z",
      "create_time": "2023-11-07T05:31:56Z",
      "date": "<string>",
      "department_id": "<string>",
      "files": [
        {
          "file_id": "<string>",
          "file_type": "FILE_TYPE_UNSPECIFIED"
        }
      ],
      "id": "<string>",
      "initiator_employee_id": "<string>",
      "number": "<string>",
      "organization_id": "<string>",
      "route": {
        "active": true,
        "id": "<string>",
        "status": "ROUTE_STATUS_UNSPECIFIED",
        "steps": [
          {
            "id": "<string>",
            "index": 123,
            "participants": [
              {
                "employee_id": "<string>",
                "id": "<string>",
                "key_type": "<string>",
                "status": "PARTICIPANT_STATUS_UNSPECIFIED"
              }
            ],
            "rule": "STEP_RULE_UNSPECIFIED",
            "status": "STEP_STATUS_UNSPECIFIED",
            "step_type": "STEP_TYPE_UNSPECIFIED"
          }
        ]
      },
      "status": "DOCUMENT_STATUS_UNSPECIFIED",
      "subject_employee_ids": [
        "<string>"
      ],
      "title": "<string>",
      "type_id": "<string>",
      "update_time": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_token": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Авторизации

X-API-Key

string

header

обязательно

Параметры запроса

limit

integer<int32>

Maximum items to return. Default 100, capped at 1000.

page_token

string

Opaque continuation token from a previous response.

status

enum<string>

Filter by status.

Доступные опции:

DOCUMENT_STATUS_UNSPECIFIED,

DOCUMENT_STATUS_DRAFT,

DOCUMENT_STATUS_ON_APPROVAL,

DOCUMENT_STATUS_ON_SIGN,

DOCUMENT_STATUS_COMPLETED,

DOCUMENT_STATUS_REJECTED,

DOCUMENT_STATUS_ARCHIVED,

DOCUMENT_STATUS_CHANGE_REQUESTED,

DOCUMENT_STATUS_REVOKED

type_id

string

Filter by document type id.

initiator_employee_id

string

Filter by initiator employee id.

created_after

string

Inclusive lower bound on the creation date, YYYY-MM-DD.

created_before

string

Inclusive upper bound on the creation date, YYYY-MM-DD.

string

Case-insensitive match against the document title or number.

updated_since

string<date-time>

Return only documents changed at or after this instant. Pair it with order_by: DOCUMENT_ORDER_UPDATED_AT_ASC to walk changes from a checkpoint; unlike the creation-date filters, it also catches documents that moved status long after they were created.

order_by

enum<string>

Result order. Defaults to newest created first.

Доступные опции:

DOCUMENT_ORDER_UNSPECIFIED,

DOCUMENT_ORDER_CREATED_AT_DESC,

DOCUMENT_ORDER_UPDATED_AT_ASC

Ответ

documents

object[]

read-only

Documents without files or route — call GetDocument for the full object.

Show child attributes

next_page_token

string

read-only

Continuation token for the next page; empty when there are no more results.

List Documents

curl --request GET \
  --url https://app.doodocs.kz/api/developer/v1/documents \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.doodocs.kz/api/developer/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.doodocs.kz/api/developer/v1/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.doodocs.kz/api/developer/v1/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.doodocs.kz/api/developer/v1/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "documents": [
    {
      "completed_at": "2023-11-07T05:31:56Z",
      "create_time": "2023-11-07T05:31:56Z",
      "date": "<string>",
      "department_id": "<string>",
      "files": [
        {
          "file_id": "<string>",
          "file_type": "FILE_TYPE_UNSPECIFIED"
        }
      ],
      "id": "<string>",
      "initiator_employee_id": "<string>",
      "number": "<string>",
      "organization_id": "<string>",
      "route": {
        "active": true,
        "id": "<string>",
        "status": "ROUTE_STATUS_UNSPECIFIED",
        "steps": [
          {
            "id": "<string>",
            "index": 123,
            "participants": [
              {
                "employee_id": "<string>",
                "id": "<string>",
                "key_type": "<string>",
                "status": "PARTICIPANT_STATUS_UNSPECIFIED"
              }
            ],
            "rule": "STEP_RULE_UNSPECIFIED",
            "status": "STEP_STATUS_UNSPECIFIED",
            "step_type": "STEP_TYPE_UNSPECIFIED"
          }
        ]
      },
      "status": "DOCUMENT_STATUS_UNSPECIFIED",
      "subject_employee_ids": [
        "<string>"
      ],
      "title": "<string>",
      "type_id": "<string>",
      "update_time": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_token": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Обзор

Endpoints

List Documents

Авторизации

Параметры запроса

Ответ