Contacts

GET /contacts

Returns a list of contacts. The list can be filtered by contact type.

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
https://skmtc.dev/fergus/apis/fergus-api/docs/contacts/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageSizeinteger

'asc'

OR

'desc'

pageCursorstring

sortField'firstName' | 'lastName' | 'createdAt'

filterContactType'CUSTOMER' | 'SITE'

filterCustomerIdnumber

filterSiteIdnumber

filterSearchTextstring

Searchable fields:

firstName
lastName
email
phoneNumber

Response

Successful Response

resultstring required

Changes

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