Navigation :

Get Projects

Gets a paginated list of project ids. You can also use this endpoint to return project details.

URLs

Environment	Method	URL
Sandbox		https://api-sandbox.fndev.net/api/rest/v2/projects
Production		https://api.fieldnation.com/api/rest/v2/projects

Path Parameters

Not applicable.

Query Parameters

Refer to Pagination for a list of additional query parameters.

Parameter	Type	Example	Notes
access_token	string	abc123defg459hijk786lmn45	Required.
list	string	list=projects_completed	Return projects by status. Optional. Returns active projects by default. Options projects_active, projects_completed, projects_cancelled, projects_all
columns	boolean	&columns=name,client	Specify columns. Optional. Columns cancellation_fee, client, finance, id, manager, name, selection_rule, service_contract, status, template

Body

Not applicable.

Response

Project information is located in the Response > results object. results will vary depending on your query parameters. Refer to Pagination for more information.

Examples

Return Completed Projects - Include Project ID, Name, and Client

https://URL?access_token=abc123defg459hijk786lmn45&list=projects_completed&columns=name,client


{
    "actions": [],
    "metadata": {},
    "params": [],
    "lists": [],
    "results": [
        {
            "id": 238,
            "name": "Alarm System Upgrade",
            "client": {
                "id": 187,
                "name": "Tech Corp"
            },
            "finance": {
                "id": 0,
                "description": "Pre-fund",
                "balance": 10000
            }
        }
    ],
    "search_text": "Search by title, keywords, client, etc.",
    "correlation_id": "projects"
}

Errors

Standard HTTP and OAuth error codes.