Skip to main content
GET
/
customers
/
{id}
/
unsigned-documents
Get customer unsigned documents
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers/{id}/unsigned-documents \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'
{
  "items": [
    {
      "content_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "file_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string
required

Optional sub-partner UUID, if provided, the unsigned documents will be filtered for the sub-partner

Path Parameters

​
id
string<uuid>
required

the ID of the Customer to get unsigned documents for

Query Parameters

​
cursor
string<uuid>

Paging: the cursor field from previous page

​
page_size
integer<uint32>
default:10

Paging: the requested page size (max 100)

Response

GET Documents Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

​
items
Document · object[]
required

The list of items

​
cursor
string<uuid>

The cursor used to fetch the next page

​
prev_cursor
string<uuid>

The cursor used to fetch the previous page