FEfergus
Sites

GET /sites

Returns a list of sites. The list can be filtered by site name, address city, and address postal code.

Request

  • Base URL
    https://api.fergus.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.fergus.com/oauth2/authorize
      Token URLhttps://auth.fergus.com/oauth2/token
    • or HTTP bearer
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pageSizeinteger
'asc'
OR
'desc'
pageCursorstring
filterSiteNamestring
filterAddressCitystring
filterAddressPostalCodestring
'name'
OR
'createdAt'
filterSearchTextstring

Searchable fields:

  • name
  • defaultContact.firstName
  • defaultContact.lastName
  • billingContact.firstName
  • billingContact.lastName
  • physicalAddress.address1
  • physicalAddress.address2

Response

Successful Response

resultstring required

Changes

No recorded changes to this operation across all 18 revisions of this API.