Get File

GET

api

files

{id}

Get File

curl --request GET \
  --url https://worker.anon.com/api/v1/files/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://worker.anon.com/api/v1/files/{id}', 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://worker.anon.com/api/v1/files/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://worker.anon.com/api/v1/files/{id}"

	req, _ := http.NewRequest("GET", url, nil)

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://worker.anon.com/api/v1/files/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "file",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "type": "CompanyInfo-EntityType-Screenshot",
  "url": "<string>",
  "size": 123,
  "content_type": "<string>",
  "migration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "type": "api_error",
  "message": "<string>"
}

{
  "type": "api_error",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Path Parameters

string<uuid>

required

File ID

Response

Success

object

enum<string>

required

Available options:

file

string<uuid>

required

Unique identifier for the file

created

string<date-time>

required

Timestamp when the file was created

name

string | null

required

Name of the file, unchanged from the source provider

type

enum<string> | null

required

Type of the file

Available options:

CompanyInfo-EntityType-Screenshot,

CompanyInfo-EntityType-HTML,

ContractorInfo-Details-CSV,

ContractorPayments-Report-CSV,

Deductions-Benefits-Screenshot,

Deductions-Benefits-HTML,

Deductions-Pay-HTML,

Deductions-Report-CSV,

Deductions-Report-Screenshot,

Deductions-Report-HTML,

DirectDeposit-Report-CSV,

EmployeeData-Report-CSV,

FederalTax-Setup-Screenshot,

FederalTax-Setup-HTML,

FederalTax-Document-PDF,

Location-Screenshot,

Location-HTML,

PayrollJournal-Report-CSV,

PTOData-Policy-Screenshot,

PTOData-Policy-HTML,

PTOData-Policy-XLSX,

SignatoryData-Screenshot,

SignatoryData-HTML,

Silver-EmployeeDetails-JSON,

Silver-EmployeeRoster-JSON,

Silver-Signatory-JSON,

Silver-Location-JSON,

Silver-ItemDetails-JSON,

Silver-EntityType-JSON,

Silver-FederalTax-PDF,

Silver-StateTax-PDF,

StateTax-Setup-Screenshot,

StateTax-Setup-HTML,

StateTax-Document-PDF,

TimeOffBalances-Report-CSV,

NavanConnect-Report-CSV,

Inventory-Report-XLSX,

ItemCatalogue-Details-CSV,

GiftCardBalances-Details-CSV,

TravelPerk-Report-CSV,

Bookings-Report-CSV,

Gold-EntityType-XLSX,

Gold-ItemDetails-XLSX,

Gold-EmployeeData-JSON,

ItemModifiers-Details-JSON,

Silver-ItemModifiers-JSON

url

string<uri>

required

Signed URL for the file

size

number

required

Size of the file in bytes

content_type

string

required

MIME type of the file

migration_id

string<uuid>

required

Unique identifier for the migration

Get File

curl --request GET \
  --url https://worker.anon.com/api/v1/files/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://worker.anon.com/api/v1/files/{id}', 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://worker.anon.com/api/v1/files/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://worker.anon.com/api/v1/files/{id}"

	req, _ := http.NewRequest("GET", url, nil)

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://worker.anon.com/api/v1/files/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "file",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "type": "CompanyInfo-EntityType-Screenshot",
  "url": "<string>",
  "size": 123,
  "content_type": "<string>",
  "migration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "type": "api_error",
  "message": "<string>"
}

{
  "type": "api_error",
  "message": "<string>"
}

Getting Started

Modal Integration

Core Resources

API Reference

Reference

Authorizations

Path Parameters

Response