Please Wait...

GET/ locations

This API returns a collection of locations for your organization. Locations often represent a physical worksite or job location. Every employee must be assigned to a location. Location assignment assists with reporting as well as manages employee E-Verify eligibility. Reference the locations data model for detailed parameter information.

Method

GET

Resource Information

Requires authentication? YES
Response formats JSON

Parameters

Parameter Required Description
page No specifies the page number from where you want to begin accessing records

Filtering

The fields in the table below can be used in the query string of a GET request, for example:

GET https://sandbox.perfectcompliance.com/v1/employees?firstName=John

Currently, it is only possible to query for exact values (no wildcards or partial matches); however, the query criteria is case-insensitive.

Parameter Type Description
addressCity string City address
addressCountry string Country address
addressState string State address
addressStreet string Physical street address
addressStreet2 string Physical street address
addressZip string Zip code address
legalEntity int Legal Entity (EIN) to which the location reports
name string Location’s name
number string Location’s number

Example

Request Example

GET https://sandbox.perfectcompliance.com/v1/locations?page_size=5&page=1

Response Example

{
    "searchResult": [
        {
            "id": 21,
            "name": "Corporate Office",
            "legalEntity": null,
            "addressState": "CA",
            "number": "CRP",
            "everifyLocation": true,
            "addressCity": "San Francisco"
        },
        {
            "id": 187142,
            "name": "4917-06211-Fresno-5501 Golden State Blvd",
            "legalEntity": null,
            "addressState": "",
            "number": "",
            "everifyLocation": true,
            "addressCity": ""
        },
        {
            "id": 187273,
            "name": "4480-17201-Aurora-1565 Aurora Ave Ln",
            "legalEntity": null,
            "addressState": "",
            "number": "",
            "everifyLocation": true,
            "addressCity": ""
        },
        {
            "id": 187084,
            "name": "4253-26218-Pontiac-1633 Highwood W",
            "legalEntity": null,
            "addressState": "",
            "number": "",
            "everifyLocation": true,
            "addressCity": ""
        },
        {
            "id": 187154,
            "name": "4468-20204-Kansas City-3150 N 7Th Trfy",
            "legalEntity": null,
            "addressState": "",
            "number": "",
            "everifyLocation": true,
            "addressCity": ""
        }
    ],
    "links": [
        {
            "href": "/v1/locations/",
            "rel": "self"
        },
        {
            "href": "/v1/locations/?page=1",
            "rel": "first"
        },
        {
            "href": "/v1/locations/?page=5",
            "rel": "last"
        },
        {
            "href": "/v1/locations/?page=2",
            "rel": "next"
        },
        {
            "href": "/v1/locations/?page=5",
            "rel": "previous"
        }
    ]
}

Single Record Request Example

GET https://sandbox.perfectcompliance.com/v1/locations/<location_id>

Single Record Response Example

{
    "id": 10714,
    "name": "4917-06211-Fresno-5501 Golden State Blvd",
    "workWednesday": "",
    "legalEntity": "",
    "number": "",
    "faxNumber": "",
    "minEmploymentAge": "",
    "workMonday": "",
    "overrideMinEmploymentAge": "",
    "workFriday": "",
    "addressCountry": "",
    "addressStreet": "3112 N. Central Ave",
    "workTuesday": "",
    "phoneNumber": "",
    "workHolidays": "",
    "workThursday": "",
    "addressCity": "Phoenix",
    "workSunday": "",
    "workSaturday": "",
    "addressState": "",
    "addressStreet2": "Suite A-200 ",
    "everifyLocation": true,
    "overrideWorkdays": "",
    "addressZip": "85012",
    "links": [
        {
            "href": "/v1/locations/18714/",
            "rel": "self"
        }
    ]
}