API Reference
Status PageRoadmapTestimoniesShare feedback

Get detailed Consumption data

get
https://api-sandbox.yousign.app/v3/consumptions/detail

Returns the consumption of your organization over a specified period.

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

🔓 Endpoint access

  • Environments: production
  • API key scopes: organization, workspace
  • Plans: plus, pro, scale
  • Add-ons (for production access): none
Query Params
string
length ≥ 1

After cursor (pagination)

integer
1 to 100
Defaults to 100

The limit of items count to retrieve.

date
required

The starting date for data retrieval.

date
required

The end date for data retrieval. The to date must be later than the from date and within one year of the from date.

string
enum
Defaults to organization

Specifies how data is grouped. By default, it returns the total consumption for the entire organization. If set to workspace, the data will be grouped by Workspace.

Allowed:
workspace_ids
array of objects

A list of Workspace IDs to filter the results.

workspace_ids
Responses

Updated about 1 month ago

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

Updated about 1 month ago