Identity, people & notifications

Get Filter Configs

Lists the org employee-sync filter configurations with deserialized filters and a hasDefault flag.

GEThttps://api.toku.com/stablecoin-payroll/get-filter-configs

Required scope: integrations:read

curl --request GET \
  --url 'https://api.toku.com/stablecoin-payroll/get-filter-configs' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "filterConfigs": [
    {
      "id": "string",
      "orgID": "string",
      "name": "string",
      "description": "string",
      "filters": {},
      "isDefault": true,
      "isActive": true,
      "syncMode": [
        "string"
      ],
      "appliesTo": [
        "string"
      ],
      "lastUsedAt": "string",
      "usageCount": 0,
      "createdBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "hasDefault": true
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Query parameters

orgIDstring

Response

200Successful response
filterConfigsobject[]required

NOTE(ck): a recursive z.lazy() schema has no contract form; TGA still checks it

Show child attributes
idstringrequired
orgIDstringrequired
namestringrequired
descriptionstring | nullrequired
filtersobject | objectrequired
Show child attributes
versionanyrequired
rootGroupanyrequired
isDefaultbooleanrequired
isActivebooleanrequired
syncModearray | nullrequired
appliesToarray | nullrequired
lastUsedAtstring | nullrequired
usageCountintegerrequired
createdBystringrequired
createdAtstringrequired
updatedAtstringrequired
hasDefaultbooleanrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits