Agent

The Agents API lets you retrieve and filter agents that have been invited to your workspace.

Get Agents

GET https://api.developer.useforms.com/v1/agents

Returns the list of all the agents in your workspace.

Query Parameters

Name	Type	Description
firstName	string	Used to filter agents using the exact first name of the agent
lastName	string	Used to filter agents using the exact last name of the agent
email	string	Used to filter agents using the exact email address of the agent
country	string	Used to filter agents using the country the agent is located in
state	string	Used to filter agents using the state the agent is located in
city	string	Used to filter agents using the city the agent is located in
startDate	string	Used to retrieve all agents created after the specified date
endDate	string	Used to retrieve all agents created before the specified date
page	number	Page number to return Default: 1
perPage	number	Number of records to return per page Default: 50
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": "605215e7546da650f981bad6",
            "firstName": "Test",
            "lastName": "Agent",
            "email": "[e-mail]",
            "profilePicture": null,
            "phone": null,
            "location": {
                "country": null,
                "state": null,
                "city": null
            },
            "groups": [],
            "createdAt": "2021-03-17T14:44:55.827Z",
            "updatedAt": "2021-03-17T14:44:55.827Z",
            "lastLoginAt": null
        }
    ],
    "_metadata": {
        "total": 6,
        "perPage": 1,
        "pageCount": 6,
        "pageLinks": {
            "current": "https://api.developer.useforms.com/v1/agents?perPage=1&page=1",
            "next": "https://api.developer.useforms.com/v1/agents?perPage=1&page=2",
            "previous": null
        }
    }
}

Get Agent By Id

GET https://api.developer.useforms.com/v1/agents/:id

Returns a single agent using the the agent's id.

Path Parameters

Name	Type	Description
id	string	Id of the agent

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200

{
    "success": true,
    "data": {
        "id": "605215e7546da650f981bad6",
        "firstName": "Test",
        "lastName": "Agent",
        "email": "[e-mail]",
        "profilePicture": null,
        "phone": null,
        "location": {
            "country": null,
            "state": null,
            "city": null
        },
        "groups": [],
        "createdAt": "2021-03-17T14:44:55.827Z",
        "updatedAt": "2021-03-17T14:44:55.827Z",
        "lastLoginAt": null
    }
}