List requests | Docusign

{
  "_links": {
    "collection": {
      "href": "https://api.docusign.com/v1/accounts/12345678/request-statuses?limit=10&ctoken=abc123"
    },
    "next": {
      "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"
    }
  },
  "response_metadata": {
    "request_id": "3f7c9e4b-851c-4f9b-89e7-123456789abc",
    "response_timestamp": "2024-10-17T14:30:00Z",
    "page_limit": 10
  },
  "requests": [
    {
      "_links": {
        "collection": {
          "href": "https://api.docusign.com/v1/accounts/12345678/request-statuses?limit=10&ctoken=abc123"
        },
        "next": {
          "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"
        }
      },
      "metadata": {
        "created_at": "2024-01-15T09:30:00Z",
        "created_by": "string",
        "modified_at": "2024-01-15T09:30:00Z",
        "modified_by": "string"
      },
      "id": "string",
      "title": "string",
      "friendly_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"
        }
      },
      "intake_form_id": "string",
      "request_type_name": "string",
      "owner": {
        "participant_id": "string",
        "email": "string",
        "name": "string"
      },
      "submitter": {
        "participant_id": "string",
        "email": "string",
        "name": "string"
      },
      "due_date": "2023-01-15",
      "document_count": 1,
      "approval_count": 1,
      "last_activity_at": "2024-01-15T09:30:00Z"
    }
  ]
}

Returns a paginated list of requests for the account, optionally filtered by status state.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account that owns the request statuses.

Query parameters

limitintegerOptional1-100Defaults to 25

The maximum number of items to return in a single page.

ctokenstringOptional

The continuation token identifying the page of results to return. Obtained from the next hypermedia link of a previous response; omit to retrieve the first page.

stateenumOptional

Filters requests by the lifecycle state of their status. Omit to return both open and closed requests.

Allowed values:

Response

The paginated list of requests for the account.

_linksobjectOptional

Hypermedia controls (HATEOAS) for navigating between pages in a paginated collection of results. Links for the current page, next page, and previous page.

response_metadataobjectOptional

Control information and metadata for the response.

requestslist of objectsOptional

The requests for the account.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error