Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Examples

// Successful request
GET /api/v2/user/profile
200
{
  "profile": {
    "last_login": "2023-11-27T09:42:50.633Z",
    "email": "admin-user-60@example.com",
    "id": 73,
    "company": null,
    "first_name": null,
    "last_name": null,
    "favorites": [],
    "about": null,
    "job_title": null,
    "phone_number": null,
    "user_role": {
      "id": 1,
      "name": "admin",
      "created_at": "2023-11-27T09:42:35.078Z",
      "updated_at": "2023-11-27T09:42:35.260Z",
      "description": "System default"
    },
    "user_groups": [],
    "terms_agreed": false,
    "sso": false,
    "avatar_url": null,
    "savedSearches": [],
    "preference": {
      "id": 15,
      "results_per_page": 40,
      "toggle_view": 0,
      "user_id": 73,
      "created_at": "2023-11-27T09:42:50.679Z",
      "updated_at": "2023-11-27T09:42:50.679Z",
      "search_attachments": false,
      "table_preset": {
        "name": "Default",
        "id": "default",
        "table_preset_columns": [
          {
            "table_preset_id": "default",
            "order": 0,
            "width": 180,
            "hidden": true,
            "name": "ID",
            "column_type": "default",
            "column_field": "_id"
          },
          {
            "table_preset_id": "default",
            "order": 1,
            "width": 180,
            "hidden": false,
            "name": "Thumbnail",
            "column_type": "default",
            "column_field": "thumbnail"
          },
          {
            "table_preset_id": "default",
            "order": 2,
            "width": 180,
            "hidden": false,
            "name": "Title",
            "column_type": "default",
            "column_field": "metadata.title.raw"
          },
          {
            "table_preset_id": "default",
            "order": 3,
            "width": 180,
            "hidden": false,
            "name": "Description",
            "column_type": "default",
            "column_field": "metadata.description.raw"
          },
          {
            "table_preset_id": "default",
            "order": 4,
            "width": 180,
            "hidden": false,
            "name": "Parent projects",
            "column_type": "default",
            "column_field": "parent_projects"
          },
          {
            "table_preset_id": "default",
            "order": 5,
            "width": 180,
            "hidden": false,
            "name": "Media type",
            "column_type": "default",
            "column_field": "media_type.raw"
          },
          {
            "table_preset_id": "default",
            "order": 6,
            "width": 180,
            "hidden": false,
            "name": "Tags",
            "column_type": "default",
            "column_field": "metadata.tags.keyword"
          },
          {
            "table_preset_id": "default",
            "order": 7,
            "width": 180,
            "hidden": false,
            "name": "Category",
            "column_type": "default",
            "column_field": "metadata.category.raw"
          },
          {
            "table_preset_id": "default",
            "order": 8,
            "width": 180,
            "hidden": false,
            "name": "Status",
            "column_type": "default",
            "column_field": "status.raw"
          },
          {
            "table_preset_id": "default",
            "order": 9,
            "width": 180,
            "hidden": false,
            "name": "Owner",
            "column_type": "default",
            "column_field": "metadata.owner.raw"
          },
          {
            "table_preset_id": "default",
            "order": 10,
            "width": 180,
            "hidden": false,
            "name": "Original filename",
            "column_type": "default",
            "column_field": "original_filename.keyword"
          },
          {
            "table_preset_id": "default",
            "order": 11,
            "width": 180,
            "hidden": false,
            "name": "Created",
            "column_type": "default",
            "column_field": "created_date"
          },
          {
            "table_preset_id": "default",
            "order": 12,
            "width": 180,
            "hidden": false,
            "name": "Modified",
            "column_type": "default",
            "column_field": "modification_date"
          },
          {
            "table_preset_id": "default",
            "order": 13,
            "width": 180,
            "hidden": false,
            "name": "External ID",
            "column_type": "default",
            "column_field": "external_id"
          }
        ]
      },
      "search_options": [
        {
          "id": 87,
          "data_field": "metadata.title"
        },
        {
          "id": 88,
          "data_field": "metadata.description"
        },
        {
          "id": 89,
          "data_field": "metadata.tags"
        },
        {
          "id": 90,
          "data_field": "ai_tags"
        },
        {
          "id": 91,
          "data_field": "exiftool_metadata.Keywords"
        },
        {
          "id": 92,
          "data_field": "exiftool_metadata.Copyright"
        },
        {
          "id": 93,
          "data_field": "exiftool_metadata.Creator"
        }
      ]
    }
  }
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters