BObox
Box Sign requests

List Box Sign requests

Changed on

Gets signature requests created by a user. If the sign_files and/or parent_folder are deleted, the signature request will not return in the list.

get/sign_requests

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/sign_requests
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Query parameters

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

sendersstring[]

A list of sender emails to filter the signature requests by sender. If provided, shared_requests must be set to true.

shared_requestsboolean

If set to true, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is false. Must be set to true if senders are provided.

Response

Returns a collection of sign requests.

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

next_markerstring nullable

The marker for the start of the next page of results.

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status