Skip to content
UltimateTeam.ai Docs

Deadline calendar

GET
/api/v1/compliance/deadlines
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/compliance/deadlines \
  --header 'X-API-Key: <X-API-Key>'

Get upcoming compliance deadlines for the tenant.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
DeadlineCalendarEnvelope

Typed envelope for GET /deadlines.

object
data
required
DeadlineCalendarResponse

Response body for the compliance deadline calendar.

Attributes: tenant_id: The tenant the calendar belongs to. upcoming_deadlines: Ordered list of upcoming deadlines.

object
tenant_id
required
Tenant Id

Tenant ID

string
upcoming_deadlines
Upcoming Deadlines

Upcoming compliance deadlines

Array<object>
DeadlineItem

A single upcoming compliance deadline.

Attributes: id: Unique identifier for the deadline. title: Short description of what is due. due_date: Date by which the obligation must be met. category: Compliance category (e.g., "tax", "employment"). description: What the business needs to do by this date. action_needed: Specific action required. days_until_due: Number of days remaining until the deadline. status: Current status (upcoming, due_soon, overdue).

object
action_needed
Action Needed

Required action

string
""
category
required
Category

Compliance category

string
days_until_due
Days Until Due

Days remaining

integer
0
description
Description

Details

string
""
due_date
required
Due Date

Due date

string format: date
id
required
Id

Deadline identifier

string
status
Status

Deadline status

string
default: upcoming
title
required
Title

Short description of the obligation

string
meta
required
ResponseMeta

Standard metadata attached to every API response.

object
request_id
required
Request Id

Unique request identifier

string
timestamp
required
Timestamp

Server timestamp of the response

string format: date-time
Example
{
  "data": {
    "upcoming_deadlines": [
      {
        "action_needed": "",
        "days_until_due": 0,
        "description": "",
        "status": "upcoming"
      }
    ]
  }
}