export_employees
Export employee data from the ServiceTitan API by specifying a tenant ID. Use a continuation token or custom date to resume or start exports, and include recent changes for quicker updates.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | Continuation token received from previous export request in "continueFrom" field. When not specified, the export process starts from the beginning. Use custom date strings, e.g. "2020-01-01" to start the export process from the certain point in time. | |
| includeRecentChanges | No | Use "true" to start receiving the most recent changes quicker. Note this may cause the same results appearing multiple times on consecutive requests. | |
| tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"from": {
"description": "Continuation token received from previous export request in \"continueFrom\" field. When not specified, the export process starts from the beginning. Use custom date strings, e.g. \"2020-01-01\" to start the export process from the certain point in time.",
"type": [
"string",
"null"
]
},
"includeRecentChanges": {
"description": "Use \"true\" to start receiving the most recent changes quicker. Note this may cause the same results appearing multiple times on consecutive requests.",
"type": [
"boolean",
"null"
]
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}