The Org Files API methods allow you to automate the sending of both your team and user CSV files to DX. These API's do not initiate imports into our system. They're meant to serve as a method by which you can have a mechanism to periodically/automatically send us the files.
API Methods
orgfiles.upload
This method simply allows you to send us a CSV file via API. It must be a csv file and can be either of type user
or team
. Once the files are sent, they can be viewed here: https://app.getdx.com/admin/org_csv_uploads
Arguments
Parameter | Description |
file | File - The csv file itself. There is a maximum file size of 10MB. Required. |
upload_type | String - Label for the import, can be either |
Example
curl -X POST 'https://api.getdx.com/orgfiles.upload' \
--header 'Authorization: Bearer <your-token>' \
--form 'file=@"/examples.csv"' \
--form 'upload_type="user"'
We don't enforce the format of these files, but they can abide by the formats spelled out here, or feel free to reach out and we can provide some recommendations based on your source system data.
orgfiles.list
You can similarly list all the uploads that you've sent via the orgfiles.upload api.
Example
curl 'https://api.getdx.com/orgfiles.list' \
--header 'Authorization: Bearer <your-token>'
{
"uploads": [
{
"id": "NTg",
"upload_type": "team",
"created_at": "2025-01-30T18:43:59.856Z",
"filename": "team_hierarchy.csv",
"download_url": "https://app.getdx.com/xyz/team_hierarchy.csv"
}
]
}