API v1
v1
View as Markdown

Get a possession tag

GET /api/v1/possession-tags/{possessionTag}

Retrieve one possession tag.

This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.

Path parameters

Sent as JSON. Anything not listed here is ignored.

possessionTag uuid Required

The id of the possession tag. A tag belonging to somebody else answers 404.

Returns

A possession tag object. A tag belonging to somebody else answers 404.

data object

The possession tag.

data.type string

Always possession_tag. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.name string

What the tag reads, such as Insured or To sell.

data.attributes.colour string

One of the eight vault colours, as a hexadecimal value.

data.attributes.created_at timestamp

When the tag was added, as a count of seconds since 1970.

data.attributes.updated_at timestamp

When its name or colour last changed, as a count of seconds, or null.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

data.links.web string

The settings screen where the tags of the account are managed, which opens for somebody signed in rather than for a key. It is the link to give a person.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

GET
curl https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031 \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031');
Response 200
{
"data": {
"type": "possession_tag",
"id": "7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
"attributes": {
"name": "Insured",
"colour": "#2f7f86",
"created_at": 1761436800,
"updated_at": 1761440400
},
"links": {
"self": "https://my.monicahq.com/api/v1/possession-tags/7a3e9c15-2b84-4d60-9f17-c5e8a2d4b031",
"web": "https://my.monicahq.com/settings/account/possession-tags"
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.