API Reference

Get Case Overview

get
https://app.docsumo.com/api/v1/external/agents//case/

Retrieves the overview of a specific case, with the option to include related data sections.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the overview of a single case. By default, only case metadata is returned, including the case name, ID, workflow state, stage, assignee, and timestamps.

To retrieve additional data, use the include query parameter to specify one or more related sections: doctypes, fields, approvals, exports, and documents. Pass them as a comma-separated list. If the include parameter is omitted, only metadata is returned.

Path Params
string
required

The unique identifier of the case type this case belongs to. You can obtain this value from the List Agents endpoint.

string
required

The unique identifier of the case. You can obtain this value from the List Cases endpoint.

Query Params
string

A comma-separated list of related data sections to include in the response. Allowed values: doctypes, fields, approvals, exports, documents.

Headers
string
required

API key used for authentication. You can find your API key in your account settings.

Responses

Updated 5 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago