Docs
V2 APIMedia

List media

Lists media of a single kind for the account. `kind` is required.

GET/api/v2/media

Lists media of a single kind for the account. kind is required.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
kind*string

Which media kind to list.

Value in

  • "file"
  • "embed"
attachable_type?string

Filter to media attached to this parent type (pair with attachable_id).

Value in

  • "property"
  • "unit"
  • "building"
  • "floor_plan"
  • "gallery"
  • "amenity"
  • "announcement"
  • "neighborhood_place"
  • "content_block"
  • "content_item"
attachable_id?string
Formatuuid
tag?string

Filter to media whose tags contain this value.

per_page?integer
Range1 <= value <= 200
Default15

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/media?kind=file"
{  "data": [    {      "kind": "file",      "media": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "url": "string",        "thumb_url": "string",        "full_url": "string",        "caption": "string",        "alt_text": "string",        "tags": [          "string"        ],        "reference_url": "string",        "reference_id": "string",        "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",        "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"      },      "attachments": [        {          "attachable_type": "property",          "attachable_id": "59195f01-f1b9-4338-a5d0-42410c1862ca",          "slot": "string",          "sort_order": 0        }      ]    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "page": 0,        "active": true      }    ],    "path": "string",    "per_page": 200,    "to": 0,    "total": 0  }}

Delete neighborhood place DELETE

Previous Page

Import media POST

Imports media by URL and attaches it to a parent resource. Requires the Media create permission and update rights on the target. Deduplicates (see the Media tag), so repeating a request is safe. For many items use POST /api/v2/media/batch. When the import lands on an existing shared asset, `attachments` in the response lists only the placements the caller can view.