Upload a schedule file

curl --request POST \
  --url https://api.getkroo.com/api/v3/schedule_files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=October Baseline' \
  --form file='@example-file' \
  --form file_type=xer \
  --form is_baseline=false \
  --form customer_project_id=123

import requests

url = "https://api.getkroo.com/api/v3/schedule_files"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "name": "October Baseline",
    "file_type": "xer",
    "is_baseline": "false",
    "customer_project_id": "123"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('name', 'October Baseline');
form.append('file', '<string>');
form.append('file_type', 'xer');
form.append('is_baseline', 'false');
form.append('customer_project_id', '123');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.getkroo.com/api/v3/schedule_files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getkroo.com/api/v3/schedule_files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getkroo.com/api/v3/schedule_files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getkroo.com/api/v3/schedule_files")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getkroo.com/api/v3/schedule_files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": 482,
  "name": "October 2026 Baseline",
  "is_baseline": false,
  "company_id": 1042,
  "customer_project": {
    "id": 123,
    "name": "<string>",
    "source": "<string>",
    "customer_project_id": "<string>"
  },
  "created_at": "2026-04-27T15:30:00Z"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Schedule Files

Upload a schedule file

Uploads a P6 schedule file (XER, XML, or PPX) and enqueues a sync job to parse and ingest it.

Required scope: write:schedule_files

Constraints:

file must be a multipart/form-data upload.
file_type must be one of xer, xml, ppx.
Within the same partner family (XER/XML share a family; PPX is its own), the most recent file’s file_type cannot change between uploads. Switching formats inside a partner returns 422 file_type_mismatch. PPX after XER is allowed because they belong to different partners.
customer_project_id, if provided, must reference a customer project owned by the authenticated company.

422 error codes:

invalid_request — missing required parameter (name, file, or file_type) or file is not a multipart upload.
file_type_mismatch — the most recent file in the same partner family uses a different file_type.
validation_error — the underlying record failed model-level validation (including unknown file_type values).

POST

schedule_files

Upload a schedule file

curl --request POST \
  --url https://api.getkroo.com/api/v3/schedule_files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=October Baseline' \
  --form file='@example-file' \
  --form file_type=xer \
  --form is_baseline=false \
  --form customer_project_id=123

import requests

url = "https://api.getkroo.com/api/v3/schedule_files"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "name": "October Baseline",
    "file_type": "xer",
    "is_baseline": "false",
    "customer_project_id": "123"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('name', 'October Baseline');
form.append('file', '<string>');
form.append('file_type', 'xer');
form.append('is_baseline', 'false');
form.append('customer_project_id', '123');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.getkroo.com/api/v3/schedule_files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getkroo.com/api/v3/schedule_files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getkroo.com/api/v3/schedule_files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getkroo.com/api/v3/schedule_files")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getkroo.com/api/v3/schedule_files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nOctober Baseline\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_type\"\r\n\r\nxer\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_baseline\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_project_id\"\r\n\r\n123\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": 482,
  "name": "October 2026 Baseline",
  "is_baseline": false,
  "company_id": 1042,
  "customer_project": {
    "id": 123,
    "name": "<string>",
    "source": "<string>",
    "customer_project_id": "<string>"
  },
  "created_at": "2026-04-27T15:30:00Z"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token obtained from POST /oauth/token. Send as Authorization: Bearer <token>. Tokens expire after 1 hour; refresh by requesting a new one with the same client credentials.

Body

multipart/form-data

name

string

required

Example:

"October Baseline"

file

required

The schedule file to upload.

file_type

enum<string>

required

Available options:

xer,

xml,

ppx

Example:

"xer"

is_baseline

boolean

default:false

customer_project_id

integer<int64> | null

Optional. Associate the file with a customer project owned by the authenticated company.

Response

File uploaded; sync job enqueued

integer<int64>

required

Unique identifier for the schedule file.

Example:

482

name

string

required

Human-readable name supplied when the file was uploaded.

Example:

"October 2026 Baseline"

is_baseline

boolean

required

True if the file was marked as a baseline at upload time; baselines are preserved for variance reporting.

Example:

false

company_id

integer<int64>

required

ID of the company that owns this file. Always equal to the authenticated client's company.

Example:

1042

customer_project

object | null

required

Project association if one was provided on upload. null for unassociated files.

Show child attributes

created_at

string<date-time>

required

ISO 8601 timestamp of when the upload was accepted.

Example:

"2026-04-27T15:30:00Z"

List schedule files Get a schedule file