Headers

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

Params

Param name Description
title
optional

Query for title

Validations:

  • Must be a String

tags
optional

Query for tags, comma-seperated

Validations:

  • Must be a String

media_types
optional

Query for media types, comma-seperated

Validations:

  • Must be a String

category
optional

Query for category

Validations:

  • Must be a String

owner
optional

Query for owner

Validations:

  • Must be a String

status
optional

Query for status

Validations:

  • Must be one of: open, approved, rejected.

Examples

GET /api/v2/search?title=Sample+Asset
200
{
  "results": [
    {
      "id": "hcOhSH4B2mofFVvOvzhO",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-22@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:27Z",
      "created_date": "2022-01-11T10:14:26Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    }
  ],
  "results_count": 1
}
GET /api/v2/search?title=Sample+Project
200
{
  "results": [
    {
      "id": "lsOhSH4B2mofFVvOyzgF",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-23@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "New Projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-01-11T10:14:30Z",
      "created_date": "2022-01-11T10:14:29Z",
      "status": "open",
      "deleted": false
    }
  ],
  "results_count": 1
}
GET /api/v2/search?tags=clip
200
{
  "results": [
    {
      "id": "msOhSH4B2mofFVvOzzjU",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-24@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:31Z",
      "created_date": "2022-01-11T10:14:31Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    }
  ],
  "results_count": 1
}
GET /api/v2/search?tags=sample
200
{
  "results": [
    {
      "id": "p8OhSH4B2mofFVvO1zje",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-25@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:34Z",
      "created_date": "2022-01-11T10:14:33Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    },
    {
      "id": "rMOhSH4B2mofFVvO2zg6",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-25@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "New Projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-01-11T10:14:35Z",
      "created_date": "2022-01-11T10:14:34Z",
      "status": "open",
      "deleted": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?media_types=project%2C+placeholder
200
{
  "results": [
    {
      "id": "scOhSH4B2mofFVvO3zj3",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-26@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:36Z",
      "created_date": "2022-01-11T10:14:35Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    },
    {
      "id": "tsOhSH4B2mofFVvO4zhJ",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-26@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "New Projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-01-11T10:14:37Z",
      "created_date": "2022-01-11T10:14:36Z",
      "status": "open",
      "deleted": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?media_types=placeholder
200
{
  "results": [
    {
      "id": "v8OhSH4B2mofFVvO6DgW",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-27@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:38Z",
      "created_date": "2022-01-11T10:14:37Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    }
  ],
  "results_count": 1
}
GET /api/v2/search?category=New+Assets
200
{
  "results": [
    {
      "id": "yMOhSH4B2mofFVvO8Dgb",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-28@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:40Z",
      "created_date": "2022-01-11T10:14:39Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    }
  ],
  "results_count": 1
}
GET /api/v2/search?owner=admin-user-29%40example.com
200
{
  "results": [
    {
      "id": "0sOhSH4B2mofFVvO-Dgb",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-29@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:42Z",
      "created_date": "2022-01-11T10:14:41Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    },
    {
      "id": "18OhSH4B2mofFVvO-zhu",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-29@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "New Projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-01-11T10:14:43Z",
      "created_date": "2022-01-11T10:14:42Z",
      "status": "open",
      "deleted": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?status=open
200
{
  "results": [
    {
      "id": "3sOiSH4B2mofFVvOADgn",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-30@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:44Z",
      "created_date": "2022-01-11T10:14:43Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    },
    {
      "id": "4cOiSH4B2mofFVvOAzh7",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-30@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "New Projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-01-11T10:14:45Z",
      "created_date": "2022-01-11T10:14:44Z",
      "status": "open",
      "deleted": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?status=approved
200
{
  "results": [
    {
      "id": "58OiSH4B2mofFVvOCDhR",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-31@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "New Assets",
      "tags": [
        "sample",
        "clip"
      ],
      "media_type": "placeholder",
      "modification_date": "2022-01-11T10:14:48Z",
      "created_date": "2022-01-11T10:14:45Z",
      "status": "approved",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false
    }
  ],
  "results_count": 1
}

Errors

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