API Reference
Status PageRoadmapTestimoniesShare feedback

Lists the Fields of a Signature Request Document.

get
https://api-sandbox.yousign.app/v3/signature_requests//documents//fields

Returns a list of Fields for a given Document. You can limit the number of items returned by using filters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Signature Request Id

uuid
required

Document ID

Query Params
string
length ≥ 1

After cursor (pagination)

integer
1 to 100
Defaults to 100

The limit of items count to retrieve.

type
object

Filter by type. Allowed operators: eq, in. Example: type[in]=text,checkbox

signer_id
object

Filter by signer_id. Allowed operators: eq. Example: signer_id[eq]=500800fc-3f91-4e86-a9c9-866809a1e3c9

name
object

Filter by name. Allowed operators: eq. Example: name[eq]=text 1

Responses

Updated 7 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago