API Call for Documents by Signer

Ryan_Coleman | Posts: 258

API Call for Documents by Signer

Monday, August 12, 2019 at 09:56am

Guys - Is there an API call where I can return the document list by signer? I know I can get this information just by doing a GET to the package but that also brings back more than what I need. I can also do the DocumentVisibility API call but then I would have to filter by associated Roles. Is there an API call that will just return a list of documents for that signer?

August 12 Created

January 21 Last Updated

6 years ago Last Reply

3 Replies

25 Views

2 Users

0 Likes

0 Links

Answered by Duo_Liang

Approved Answer

Duo_Liang | Posts: 3777

Reply to: API Call for Documents by Signer

Monday, August 12, 2019 at 11:41am

Hi Ryan, There's another API allowing you to retrieve all approvals assigning to a role:

GET /api/packages/{packageId}/signers/{signer_id_or_email}/approvals

Response payload could look like below:

[
    {
        "documentId": "efc058bf9f0c261947c62a8d199be5d5ea6495ca102c8076",
        "approvals":[
        ...
        ]
    },
    {
        "documentId": "default-consent",
        "approvals": [
        ...
        ]
    },
    {
        "documentId": "91a88db05a2f122ab214ef6f5933219658ade8d81b7f1035",
        "approvals": []
    }
]

So if the "approvals" array is not null and empty, the document is for the signer. I think following this API could be easier for you to implement in code. The side effects are, you need to make multiple calls to get information for all signers, and only document IDs are returned through the API. Hope this could help! Duo

Ryan_Coleman | Posts: 258

Reply to: API Call for Documents by Signer

Monday, August 12, 2019 at 11:44am

Duo, This is exactly what I was looking for!

Duo_Liang | Posts: 3777

Reply to: API Call for Documents by Signer

Monday, August 12, 2019 at 11:59am

Glad to help! :) And I noticed that we didn't mention it in our "Retrieve All Signatures" Guide REST tab, I will fix it ASAP. Duo