Get request | Docusign | Documentation

{
  "id": "string",
  "intake_form_id": "string",
  "status": {
    "id": "string",
    "name": "string",
    "state": "string",
    "metadata": {
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "modified_at": "2024-01-15T09:30:00Z",
      "modified_by": "string"
    }
  },
  "title": "string",
  "_actions": {
    "add_document": {
      "href": "string",
      "method": "string",
      "description": "string"
    },
    "share": {
      "href": "string",
      "method": "string",
      "description": "string"
    }
  },
  "_links": {
    "collection": {
      "href": "https://api.docusign.com/v1/accounts/12345678/request-statuses?limit=10&ctoken=abc123"
    },
    "self": {
      "href": "https://api.docusign.com/v1/accounts/12345678/request-statuses?limit=10&ctoken=abc123"
    },
    "shares": {
      "href": "https://api.docusign.com/v1/accounts/12345678/request-statuses?limit=10&ctoken=abc123"
    }
  },
  "approval_count": 1,
  "document_count": 1,
  "due_date": "2023-01-15",
  "friendly_id": "string",
  "last_activity_at": "2024-01-15T09:30:00Z",
  "metadata": {
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "string",
    "modified_at": "2024-01-15T09:30:00Z",
    "modified_by": "string"
  },
  "owner": {
    "participant_id": "string",
    "email": "string",
    "name": "string"
  },
  "request_type_name": "string",
  "request_url": "string",
  "submitter": {
    "participant_id": "string",
    "email": "string",
    "name": "string"
  }
}

Returns the current state of a single request, including its status, counts, and available actions.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account that owns the request statuses.

requestIdstringRequiredformat: "uuid"

The ID of the request (Agreement Desk ticket) the document belongs to.

Response

The request.

idstringRead-onlyformat: "uuid"

The unique identifier of the request.

intake_form_idstringformat: "uuid"

The identifier of the intake form the request was created from.

statusobject

titlestring

The title of the request.

_actionsobjectOptional

The set of actions available on a request.

_linksobjectOptional

Hypermedia links for a request.

approval_countintegerOptional

The number of approvals on the request.

document_countintegerOptional

The number of documents attached to the request.

due_datedate or nullOptional

The date the request is due.

friendly_idstring or nullOptionalRead-only

A human-readable identifier for the request (e.g. REQ-0042).

last_activity_atdatetime or nullOptional

Timestamp of the most recent activity on the request.

metadataobjectOptional

Audit and provenance metadata for a resource.

ownerobjectOptional

A concise reference to a participant, such as the creator of a resource.

request_type_namestring or nullOptionalRead-only

The display name of the request type.

request_urlstring or nullOptionalRead-onlyformat: "uri"

Deep link to the request in the Agreement Desk UI.

submitterobjectOptional

A concise reference to a participant, such as the creator of a resource.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error