Query Single To-Do

Permissions

The Identity Management API is authorized at the application dimension. Before calling the interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.

Permission Code	Description
app_todo_msg	Application-side task to-do management permission
all	Full interface read/write permissions

Request Description

GET https://{your_domain}/api/v2/tenant/todo/task/{todo_id}

Request Headers

Parameter Name	Chinese Name	Required	Type	Description
Authorization	Authorization	Yes	String	Format: Bearer {access_token}
Content-Type	Content Type	Yes	String	Fixed value: application/json; charset=utf-8

Request Example

None

Request Parameters

Parameter Name	Chinese Name	Required	Type	Description
todo_id	To-Do ID	Yes	String	To-Do ID

Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": "20220809162630548-9D52-E085BA68A",
    "source_id": "20220119111936362-77E4-C4A94DFC6",
    "source_type": "APP",
    "title": "To-do Title 67",
    "content": "To-do Content 67",
    "message_type": "TEXT",
    "external_id": "67",
    "detail_url": {
        "web_url": "https://www.baidu.com/",
        "mobile_url": "https://www.baidu.com/"
    },
    "user_id": "20220615161810047-F95F-B61E1C44F",
    "deal": false,
    "dealt_at": null,
    "ending_at": "2022-08-14 12:00:00",
    "created_at": "2022-08-09 16:26:30.548",
    "updated_at": "2022-08-09 16:26:30.548"
}


Error Example:
HTTP/1.1 400 Bad Request
{
  "error_code": "TODOTASK.0001",
  "error_msg": "To-do does not exist"
}

Response Parameters

Parameter Name	Chinese Name	Type	Description
id	Primary Key ID	String	Primary Key ID, unique
source_id	Source ID	String	Source ID
source_type	Source Type	String	SYSTEM=System APP=Application
title	Title	String	Title
content	Content	String	Content
message_type	Message Type	String	TEXT=Text MARKDOWN=markdown
created_at	Creation Time	String	Creation Time
updated_at	Modification Time	String	Modification Time
dealt_at	Processing Time	String	Processing Time
ending_at	Deadline	String	Deadline
userId	User ID	String	User ID
deal	Processing Status	Boolean	Processing Status
external_id	External To-do ID	String	Third-party to-do ID
detail_url	URL for redirecting to the to-do event	Map	Includes URLs for PC and mobile
--web_url	PC URL	String	PC URL
--mobile_url	Mobile URL	String	Mobile URL

Error Codes

Status Code	Error Code	Error Message	Action
402	TODOTASK.0001	Todo does not exist	Please check if the corresponding todo exists