Skip to main content
GET
/
files
/
read
Read file by id
curl --request GET \
  --url https://api.obselite.com/v0/files/read \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "organization": {},
  "user": {},
  "userBanner": {},
  "userAvatar": {},
  "organizationAvatar": {},
  "comments": [
    {}
  ],
  "cycles": [
    {}
  ],
  "resources": [
    {}
  ],
  "tasks": [
    {}
  ],
  "teams": [
    {}
  ],
  "activities": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

The API token generated from the Obselite dashboard

Query Parameters

filter
string

Encoded JSON to search and refine lists, see filtering

include
string

Available options: userBanner, userAvatar, organizationAvatar, comments, cycles, resources, tasks, teams, activities

id
string<uuid>

Response

Successful response

id
string<uuid>
required

File UUID

url
string | null
organization
object | null

The organization that owns this file, following the organization schema

user
object | null

The user who uploaded or owns this file, following the user schema

userBanner
object | null

The user's banner image file, following the file schema

userAvatar
object | null

The user's profile picture file, following the file schema

organizationAvatar
object | null

The organization's profile picture file, following the file schema

comments
array
cycles
array
resources
array
tasks
array
teams
array
activities
array