Full Data endpoint

This endpoint allows the consumer to start a data loader operation for configured entities to extract all the data of the configured tables in one single request.
This means that this endpoint will provide the complete data stored in our tables which is useful for initial loads of systems.
The consumer can also check the status of the operation, cancel it or delete the files created.

However, there is a limitation in the payroll table where the endpoint will only retrieve the data contained in the payroll table for the current and previous years.
Examples:

Today is 1st November 2025 -> the api will retrieve the data from 1st January 2024.
Today is 15th February 2025 -> the api will retrieve the data from 1st January 2024.

Url: https://data.youforce.com/data/v1/fulldata

POST → /data/v1/fulldata

With this action, the consumer will start a data loader operation for the selected configured entities.
It will run multiple jobs, one per entity/table configured or just one if the entity parameter is filled in.

If a new request is sent while another request is still being processed, the response will contain a 409 error.

Parameters

Header parameters: Authorization (Bearer)
Path parameters: None
Query parameters: None
Body parameters:
- ConfigurationId: Explicit configuration that the consumer wants to apply. If no value is provided here, then the default configuration set as default in the Configuration API will be used.
- FileFormat: Format in which the data will be returned in the file. Currently only csv and json formats are accepted.
- Entity: Selected entity for which the operation will be performed. The operation will run just one job for that entity and the results will contain data for that entity alone. If no value is provided here, then all the entities defined for that configuration will be triggered, creating a job and an output file per entity.
- Version: in case that a job can have multiple versions, the desired version. In case no value is provided here, then the last version will be taken.

curl --location 'https://data.youforce.com/data/v1/fulldata' \
--header 'Authorization: Bearer abc’
--header 'Content-Type: application/json' \
--data '{
  "configurationId": "testing-default-4028868",
  "fileFormat": "csv",
  "entity": "sickness-case",
  "version": 1
}'

Response

If all went well it will a created response code → 202 Accepted
The body of the response will also provide an operation ID that can be used for further queries in this API (check next endpoints).

{
    "operationId": "88549862-af91-49c1-9545-683edd948931"
}

PUT → /data/v1/fulldata/{fulldataOperationId}/retry

With this action, the consumer can retry a failed data loader operation identified by the ‘operationId’ value provided in response of the POST action when they requested the full data.
This means that if there are jobs within the operation that have failed, the api will retry just these failed jobs.
If there is an operation with no failed jobs and the retry action is triggered, the api will return a 404 Not Found code.

Parameters

Header parameters: Authorization (Bearer)
Path parameters:
- OperationId: Id of the operation that was started in the POST action when creating a new Operation
Query parameters: None
Body parameters: None

curl --location --request PUT 'https://data.youforce.com/data/v1/fulldata/ed41e267-8cbb-4e08-b4bf-60d7a26d7fd8/retry' \
--header 'Authorization: Bearer abc’

Response

If all went well it will a created response code → 202 Accepted

POST → /data/v1/fulldata/{fulldataOperationId}/cancel

With this action, the consumer can cancel a data loader operation identified by the ‘operationId’ value provided in response of the POST action when they requested the full data.
This means that it will stop all the jobs of that concrete operation that are in progress: it cancels a job only if it is not completed yet, a job that has been completed cannot be cancelled.
In case the operation has been completed already, then it will return a 400 Bad Request code.
In case there are no jobs pending to be processed or being processed at the time, then the api will return a 404 Not Found code.

Parameters

Header parameters: Authorization (Bearer)
Path parameters:
- OperationId: Id of the operation that was started in the POST action when creating a new Operation
Query parameters: None
Body parameters: None

curl --location --request POST 'https://data.youforce.com/data/v1/fulldata/ed41e267-8cbb-4e08-b4bf-60d7a26d7fd8/cancel' \
--header 'Authorization: Bearer abc’

Response

If all went well it will a created response code → 204 No content

DELETE → /data/v1/fulldata/{fulldataOperationId}

With this action, the consumer can delete the files created by a data loader operation identified by the ‘operationId’ value provided in response of the POST action when they requested the full data.
This means that it will delete all downloadable files of the jobs that has been completed for the specified Operation.
It will return a 400 Bad Request code in case the jobs are not completed.

Parameters

Header parameters: Authorization (Bearer)
Path parameters:
- OperationId: Id of the operation that was started in the POST action when creating a new Operation
Query parameters: None
Body parameters: None

curl --location --request DELETE 'https://data.youforce.com/data/v1/fulldata/ed41e267-8cbb-4e08-b4bf-60d7a26d7fd8' \
--header 'Authorization: Bearer abc’

Response

If all went well it will a created response code → 204 No Content

GET → /data/v1/fulldata/{fulldataOperationId}/status

With this action, the consumer will get the status of the data loader operation identified by the ‘operationId’ value provided in response of the POST action when they requested the full data.
This means that you will receive the processing status of each job started within that concrete operation and an overall status of the operation.
When an operation contains several jobs with different status, the operation may be in a partial state:

PartiallyFailed: when some of the jobs have failed and the rest have been completed.
PartiallyCancelled: when some of the jobs have been cancelled but the rest have been completed.
PartiallyDeleted: when some of the jobs have been deleted (therefore, the files deleted) but the rest have been completed.

Parameters

Header parameters: Authorization (Bearer)
Path parameters:
- OperationId: Id of the operation that was started in the POST action when creating a new Operation
Query parameters: None
Body parameters: None

curl --location 'https://data.youforce.com/data/v1/fulldata/88549862-af91-49c1-9545-683edd948931/status' \
--header 'Authorization: Bearer abc’

Response

If all went well it will return an OK response code → 200 OK
Explanation of the fields:

operationId: Operation Id requested
configurationId: configuration Id applied for creating the output
Status: status of the overall operation. Possible values are: Pending, Completed, Cancelled and Failed.
Jobs: array with the status of the jobs individually
Id: job Id for individual requests
- Entity: entity related to that job
- Version: version of the job that is being delivered
- Status: status of that concrete job. Possible values are: Pending, Completed, Cancelled and Failed.
- createdAt: date and time when the request was created
- startedAt: date and time when the job was started
- completedAt: date and time when the job was finished
- cancelledAt: date and time when the job was cancelled
- failedAt: date and time when the job failed
- failedReason: reason why the job failed
- totalCount: amount of rows that will be returned
- processedCount: amount of rows that has been process at the time of this request
- expirationDate: date and time when the file that contains the data retrieved will be eliminated from our systems
- Links: array with all the link to download the files that has been processed successfully

Example of output with pending status:

{
    "operationId": "88549862-af91-49c1-9545-683edd948931",
    "configurationId": "testing-default-4028868",
    "status": "Pending",
    "jobs": [
        {
            "id": "0d629dbc-8d49-46df-8c0a-8469a67fd7d3",
            "entity": "sickness-case",
            "version": 1,
            "status": "Pending",
            "createdAt": "2025-10-30T13:24:33.078654Z"
        }
    ]
}

Example of output with finished status:

{
    "operationId": "88549862-af91-49c1-9545-683edd948931",
    "configurationId": "testing-default-4028868",
    "status": "Completed",
    "jobs": [
        {
            "id": "0d629dbc-8d49-46df-8c0a-8469a67fd7d3",
            "entity": "sickness-case",
            "version": 1,
            "status": "Completed",
            "createdAt": "2025-10-30T13:24:33.078654Z",
            "startedAt": "2025-10-30T13:25:05.183246Z",
            "completedAt": "2025-10-30T13:25:08.219779Z",
            "totalCount": 400,
            "processedCount": 400,
            "expirationDate": "2025-10-31T13:25:08.219808Z",
            "links": {
                "download": "https://data.youforce.com/data/v1/jobs/0d629dbc-8d49-46df-8c0a-8469a67fd7d3"
            }
        }
    ]
}

Information regarding Data API CONTROL AVAILABLE

Full Data endpoint

POST → /data/v1/fulldata

Parameters

Response

PUT → /data/v1/fulldata/{fulldataOperationId}/retry

Parameters

Response

POST → /data/v1/fulldata/{fulldataOperationId}/cancel

Parameters

Response

DELETE → /data/v1/fulldata/{fulldataOperationId}

Parameters

Response

GET → /data/v1/fulldata/{fulldataOperationId}/status

Parameters

Response