v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

generalSettings

find many generalSettings

Find many generalSettings (with filtering, projection, pagination and limiting). You can use filters in the query parameters (properly URL encoded) to restrict the search results:

To restrict the search to specific values for a given field name, you can use the following syntax: filter[where][fieldName][eq]=value. Note that you can also nest the filter object to filter on multiple fields, like so: filter[where][and][0][fieldName1][eq]=value1&filter[where][and][1][fieldName2][eq]=value2. You can also use operators like gt, gte, lt, lte, ne, in, nin, etc.
To limit the number of results returned by the query, use the following syntax: filter[limit]=25&filter[skip]=25
To only return specific fields, use the projection query parameter. Usage is as follows: filter[fields][fieldName1]=true&filter[fields][fieldName2]=true.

get/api/serviceattendance/generalSettings

Query parameters

whereParametersFilterWhere

fieldsParametersFilterFields

limitnumber

skipnumber

orderstring[]

{
  "limit": 10,
  "order": [
    "prop DESC"
  ]
}

Response

One or many generalSetting documents found. Wrapped in a JsonAPI root response with collection of documents as data.

Example response

{
  "data": [
    {
      "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
      "createdAt": "2021-05-05T01:02:03.924Z",
      "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
      "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
      "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
      "lastUpdatedByAudience": "employer",
      "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
      "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
      "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
      "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
      "companyUuid": "cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b",
      "payrollIntegration": {
        "fileFormat": "xlsx",
        "templateFile": {
          "redirectUrl": "https://example.com/timesheets.xlsx",
          "uuid": "cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b",
          "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
          "key": "public/companies/cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b/timesheets/timesheets.xlsx",
          "name": "timesheets.xlsx",
          "size": 123456,
          "lastModified": 1679033600
        },
        "webhook": {
          "callbackUrl": "https://example.com/callback",
          "apiKey": "1234567890",
          "method": "POST"
        }
      },
      "payPeriod": {
        "startDayOfWeek": 6
      },
      "kiosk": {
        "workerLoginMethods": [
          "mobilePhone.number"
        ]
      }
    }
  ],
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}