GET /data/user/context
Jwt authorization

Retrieve context information required to properly run a full application connected to the API. Returns user, project, and system configuration data.

Responses

  • 200 application/json

    Context information for running a full app connected to the API

    Hide response attributes Show response attributes object
    • user object

      Current user information

    • projects array[object]

      Available projects

    • departments array[object]

      Available departments

    • asset_types array[object]

      Available asset types

    • task_types array[object]

      Available task types

    • task_status array[object]

      Available task statuses

    • custom_actions array[object]

      Available custom actions

    • status_automations array[object]

      Available status automations

    • studios array[object]

      Available studios

    • notification_count integer

      Number of unread notifications

    • persons array[object]

      Available persons

    • project_status array[object]

      Available project statuses

    • search_filters array[object]

      Available search filters

    • search_filter_groups array[object]

      Available search filter groups

    • preview_background_files array[object]

      Available preview background files
GET /data/user/context 
curl -X GET "http://api.example.com/data/user/context" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/data/user/context"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request GET 'http://api.example.com/data/user/context' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "user": {
    "id": "uuid",
    "name": "John Doe"
  },
  "projects": [
    {
      "id": "uuid",
      "name": "Project 1"
    }
  ],
  "departments": [
    {
      "id": "uuid",
      "name": "Animation"
    }
  ],
  "asset_types": [
    {
      "id": "uuid",
      "name": "Character"
    }
  ],
  "task_types": [
    {
      "id": "uuid",
      "name": "Modeling"
    }
  ],
  "task_status": [
    {
      "id": "uuid",
      "name": "In Progress"
    }
  ],
  "custom_actions": [
    {
      "id": "uuid",
      "name": "Custom Action"
    }
  ],
  "status_automations": [
    {
      "id": "uuid",
      "name": "Auto Status"
    }
  ],
  "studios": [
    {
      "id": "uuid",
      "name": "Studio Name"
    }
  ],
  "notification_count": 5,
  "persons": [
    {
      "id": "uuid",
      "name": "John Doe"
    }
  ],
  "project_status": [
    {
      "id": "uuid",
      "name": "Active"
    }
  ],
  "search_filters": [
    {
      "id": "uuid",
      "name": "My Filter"
    }
  ],
  "search_filter_groups": [
    {
      "id": "uuid",
      "name": "Filter Group"
    }
  ],
  "preview_background_files": [
    {
      "id": "uuid",
      "name": "background.jpg"
    }
  ]
}