Skip to content

Get a user asset ​

GET/api/v2/users/me/assets/{pk}/

User assets are the calling user's own uploads, such as an avatar or cover image. Read a single user asset by id.

Path Parameters ​

pk:requiredstring (uuid)

The user asset id.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: asset_url, attributes, content_type, created_at, created_by_id, entity_type, id, is_uploaded, name, size, user_id.

Scopes ​

assets:read

Errors ​

StatusCodeCause
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan or is switched off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Get a user asset
bash
curl -X GET \
  "https://api.plane.so/api/v2/users/me/assets/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "asset_url": "https://example.com",
  "attributes": null,
  "content_type": "example",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "entity_type": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_uploaded": false,
  "name": "Example name",
  "size": 1,
  "user_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "No user asset matches the given query."
}