Form Shares

The Form Shares API lets you retrieve and filter all the form share settings for the forms in your workspace.

Get Form Shares

GET https://api.developer.useforms.com/v1/form-shares

Returns the list of all the form shares in your workspace.

Query Parameters

Name	Type	Description
name	string	Used to filter form shares using the exact name of the share.
form	string	Used to filter form shares using the id of the form that was shared.
startDate	string	Used to retrieve all form shares created after the specified date
endDate	string	Used to retrieve all form shares created before the specified date
page	number	Page number to return Default: 1
perPage	number	Number of records to return per page Default: 50
sortBy	string	Property to use in sorting the form shares. Valid: [createdAt, name] Default: createdAt
sortOrder	string	Specify whether to sort records in ascending or descending order. Valid: [asc, desc] Default: desc
includeData	boolean	Specify whether to return the data key in the endpoint response. Valid: [true, false] Default: true
includeMetadata	boolean	Specify whether to return the _metadata key in the endpoint response. Valid: [true, false] Default: true

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200

{
    "success": true,
    "data": [
        {
            "id": "605216e1546da650f981bada",
            "name": "Test Share",
            "form": {
                "id": "5fa7f1fac9c3dc06f8e17466",
                "name": "Sample Form",
                "description": "My sample form",
                "createdAt": "2020-11-08T13:26:18.436Z",
                "updatedAt": "2021-03-19T09:52:15.382Z"
            },
            "url": "https://app.useforms.com/response-form/YjmjcT_I71DmfjzH",
            "isSuspended": false,
            "settings": {
                "dueDate": null,
                "hasValidation": false,
                "notification": "off",
                "responses": {
                    "allowMultiple": true,
                    "totalExpected": null,
                    "totalPerAgent": null
                }
            },
            "createdBy": {
                "id": "5fa7ebdac9c3dc06f8e17452",
                "firstName": "Test",
                "lastName": "User",
                "email": "[e-mail]",
                "profilePicture": null
            },
            "createdAt": "2021-03-17T14:49:05.280Z",
            "updatedAt": "2021-03-17T15:12:36.681Z"
        }
    ],
    "_metadata": {
        "total": 11,
        "perPage": 1,
        "pageCount": 11,
        "pageLinks": {
            "current": "http://api.developer.useforms.com/v1/form-shares?perPage=1&page=1",
            "next": "http://api.developer.useforms.com/v1/form-shares?perPage=1&page=2",
            "previous": null
        }
    }
}

Get Form Share By Id

GET https://api.developer.useforms.com/v1/form-shares/:id

Returns a single form share using the the form share's id.

Path Parameters

Name	Type	Description
id	string	Id of the form share

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200

{
    "success": true,
    "data": {
        "id": "605216e1546da650f981bada",
        "name": "Test Share",
        "form": {
            "id": "5fa7f1fac9c3dc06f8e17466",
            "name": "Sample Form",
            "description": "My sample form",
            "createdAt": "2020-11-08T13:26:18.436Z",
            "updatedAt": "2021-03-19T09:52:15.382Z"
        },
        "url": "https://app.useforms.com/response-form/YjmjcT_I71DmfjzH",
        "isSuspended": false,
        "settings": {
            "dueDate": null,
            "hasValidation": false,
            "notification": "off",
            "responses": {
                "allowMultiple": true,
                "totalExpected": null,
                "totalPerAgent": null
            }
        },
        "createdBy": {
            "id": "5fa7ebdac9c3dc06f8e17452",
            "firstName": "Test",
            "lastName": "User",
            "email": "[e-mail]",
            "profilePicture": null
        },
        "createdAt": "2021-03-17T14:49:05.280Z",
        "updatedAt": "2021-03-17T15:12:36.681Z",
        "recipients": [
            {
                "agent": {
                    "id": "604b24c3d960c13284359840",
                    "firstName": "Test",
                    "lastName": "Agent 1",
                    "email": "[e-mail]",
                    "phone": null,
                    "profilePicture": null
                },
                "isSuspended": false,
                "shareDate": "2021-03-17T15:12:36.680Z"
            },
            {
                "agent": {
                    "id": "605215e7546da650f981bad6",
                    "firstName": "Test",
                    "lastName": "Agent 2",
                    "email": "[e-mail]",
                    "phone": null,
                    "profilePicture": null
                },
                "isSuspended": false,
                "shareDate": "2021-03-17T15:11:30.882Z"
            }
        ]
    }
}