Skip to content
wrktr docs

Read a file

GET
/api/orgs/{org}/projects/{project}/file
curl --request GET \
  --url 'https://api.wrktr.com/api/orgs/example/projects/example/file?branch=example&path=example' \
  --header 'Authorization: Bearer <token>'

The file at the branch head, or its draft if there is one.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string
project
required
string

Query Parameters

Section titled “Query Parameters”
branch
required
string
path
required
string

Responses

Section titled “Responses”

200

Section titled “200”

FileAtHead

Media typeapplication/json
object
path
required
string
headSha
required
string
content
required
Any of:
string
binary
required
boolean
drafted
required
boolean
Examplegenerated
{
  "path": "example",
  "headSha": "example",
  "content": "example",
  "binary": true,
  "drafted": true
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
_tag
required
string
Allowed values: Unauthorized
message
required
string
Example
{
  "_tag": "Unauthorized"
}

404

Section titled “404”

ProjectNotFound | BranchNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ProjectNotFound
project
required
string
Example
{
  "_tag": "ProjectNotFound"
}