Get Talent by Group

Gets a paginated list of providers by talent pool group. From the Field Nation Platform, you can access this information from the Workforce > Talent section.

URLs

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

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.
default_view string default_view=list Required.
f_preferred_groups integer &f_preferred_groups=13 Required. Refer to Get Talent Group to return Talent Pool List ids.

Body

Not applicable.

Response

Returns provider information by Talent Pool List id.

Examples

{
    "actions": [
        "add_managed",
        "add_to_preferred_group",
        "remove_from_preferred_group"
    ],
    "metadata": {
        "total": 1,
        "page": 1,
        "pages": 1,
        "per_page": 100,
        "columns": "badges:90,thumbnail:80,full_name:150,city:80,state:50,rating:100,jobs:100,last_active:90,preferred_groups:175,correlation_id:175",
        "view": "list",
        "sort": "",
        "order": "asc",
        "list": "providers_marketplace",
        "available_columns": [],
        "available_filters": []
    },
    "params": [],
    "lists": [],
    "f_preferred_groups": "13",
    "fs_preferred_groups": true,
    "results": [
        {
            "id": 557,
            "w2": false,
            "correlation_id": "eb1899be0f2f15d3a0add331c0d6afbd6faeab38",
            "worked_with": false,
            "has_request": false,
            "managed": false,
            "rating": {
                "marketplace": {
                    "total_ratings": 0,
                    "stars": 0
                },
                "my_company": {
                    "total_ratings": 0,
                    "stars": 0
                }
            },
            "preferred_groups": {
                "metadata": {
                    "total": 2,
                    "per_page": 2,
                    "pages": 1,
                    "page": 1
                },
                "actions": [
                    "add"
                ],
                "results": [
                    {
                        "id": 0,
                        "notes": "",
                        "name": "Uncategorized",
                        "count": 2,
                        "created": {
                            "utc": "2018-12-13 22:08:13"
                        },
                        "actions": [
                            "delete"
                        ]
                    },
                    {
                        "id": 13,
                        "notes": "",
                        "name": "ATM Repair",
                        "count": 1,
                        "created": {
                            "utc": "2018-12-17 17:18:55"
                        },
                        "actions": [
                            "delete"
                        ]
                    }
                ]
            },
            "protec": false,
            "drug_tests": {
                "metadata": {
                    "total": 0,
                    "per_page": 0,
                    "page": 1,
                    "pages": 1
                },
                "results": []
            },
            "worker_compensation": false,
            "background_checks": {
                "metadata": {
                    "total": 0,
                    "per_page": 0,
                    "page": 1,
                    "pages": 1
                },
                "results": []
            },
            "last_name": "Provider",
            "first_name": "Marketplace",
            "thumbnail": "https://s3.amazonaws.com/dev.fieldnation/profile_image/557-57755b2635671.png",
            "last_active": {
                "utc": "2018-12-14 16:47:01"
            },
            "jobs": {
                "company": 0,
                "marketplace": 3
            },
            "city": "Northrop",
            "state": "MN",
            "actions": [
                "menu_notification_settings",
                "menu_support",
                "menu_legal",
                "menu_privacy",
                "can_switch_to_old_nav",
                "onboarded",
                "edit"
            ]
        }
    ],
    "search_text": "Search by name, address, fields, email, usernames, etc.",
    "correlation_id": "marketplace"
}

Errors

Standard HTTP and OAuth error codes.