GET
/v1/definitions/{key}/rows/{rowId}/detailRead one record in full: cells, people, files, activity
The deal record page's opening read, in one call: the deal's cells, its cross-board relations, both lifecycle tracks, its files, what is still owed on it, its tasks, its people by role and its latest activity. Reach for this rather than assembling a record out of six reads; reach for get_definitions_key_rows_rowId_relationships when only the links are wanted. Deals page only.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
keypath · stringrequired
rowIdpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:keystringoptional
:rowIdstringoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": {
"activity": [
{
"action": "string",
"actorKind": "string",
"actorUserId": "",
"createdAt": "string",
"detail": "string",
"entityId": "",
"entityKind": "string",
"entityRowId": "",
"entityUuid": "string",
"id": "",
"requestId": ""
}
],
"assignments": {},
"closings": [
{
"closedAt": "string",
"closedBy": "string",
"createdAt": "string",
"dealRowId": "",
"id": "",
"note": "string",
"outcome": "string",
"reason": "string",
"reasonCode": "string",
"stage": "string",
"status": "string",
"taskId": "",
"updatedAt": "string"
}
],
"deal": {
"archived_at": "string",
"assignees": {},
"cells": {},
"createdBy": "string",
"display": {},
"externalId": "",
"groupId": "",
"id": "",
"position": 1,
"source": "string"
},
"documentRequests": [
{
"cancelledAt": "string",
"documentType": "string",
"dueAt": "string",
"fulfilledAt": "string",
"fulfilledBy": "string",
"fulfilledFileId": "",
"id": "",
"note": "string",
"periods": "string",
"requestedAt": "string",
"requestedBy": "string",
"rowId": "",
"sentAt": "string",
"sentMedium": "string",
"sentMessageId": "",
"sentTo": "string",
"status": "string"
}
],
"files": [
{
"contentType": "string",
"createdAt": "string",
"documentType": "string",
"folderId": "",
"id": "",
"name": "string",
"periodEnd": "string",
"periodStart": "string",
"rowId": "",
"sizeBytes": "string",
"source": "string",
"sourceDetail": "string",
"statementStatus": "string",
"uploadedBy": "string"
}
],
"lifecycle": {
"contract": "string",
"funding": "string"
},
"relations": {
"lead": "string",
"lenders": [
"string"
],
"merchant": "string",
"offers": [
"string"
],
"submissions": [
"string"
]
},
"riskSignals": [
{
"context": "string",
"dealRowId": "",
"detail": "string",
"id": "",
"label": "string",
"raisedAt": "string",
"signalKey": "string",
"source": "string",
"submissionShareId": "",
"tone": "string",
"updatedAt": "string"
}
],
"tasks": [
{
"assigneeAccountId": "",
"assigneeUserId": "",
"blockedByTaskId": "",
"calendarEventId": "",
"cancellationReason": "string",
"cancelledAt": "string",
"completedAt": "string",
"completedByUserId": "",
"createdAt": "string",
"createdByKind": "string",
"createdByUserId": "",
"customerActionRequired": "string",
"customerVisible": "string",
"description": "string",
"detail": "string",
"dueAt": "string",
"entityId": "",
"entityKind": "string",
"escalated": "string",
"escalatedAt": "string",
"escalationCount": "string",
"id": "",
"nodeId": "",
"outcome": "string",
"outcomeNotes": "string",
"parentTaskId": "",
"priority": "string",
"requestedDocumentType": "string",
"slaBreachAt": "string",
"slaBreached": "string",
"slaWarned": "string",
"slaWarningAt": "string",
"source": "string",
"startedAt": "string",
"status": "string",
"tags": "string",
"taskType": "string",
"threadId": "",
"title": "string",
"updatedAt": "string",
"workflowExecutionId": ""
}
]
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired