API v1
v1
View as Markdown

List vaults

GET /api/v1/vaults

List your vaults, in the order you arranged them.

The order is the one you gave your vaults, which is the order they appear in when you switch between them. It is not the order they were made in, so a vault you moved to the top comes back at the top.

A deleted vault is never listed. An account holding no vault answers with an empty list rather than an error, since that is the state every account starts in.

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

Query parameters

Sent as JSON. Anything not listed here is ignored.

page integer Optional default: 1

Which page to answer with.

per_page integer Optional default: 25

How many vaults one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.

Returns

A page of vault objects, and how many there are in all.

data array

The vaults on this page. An empty list rather than an error when there are none.

data[] object

One vault.

data[].type string

Always vault. 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.slug string

The readable name the vault is addressed by, built from its name and unique within your account. It is not stable: renaming the vault rebuilds it and the previous one stops answering, which is why a stored reference should be the id. Nothing lets you choose or edit it.

data[].attributes.name string

What the vault is called. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here.

data[].attributes.description string

What the vault is for, up to 65535 characters, or null when nobody said. Null is the ordinary state of a vault nobody described, not a sign of anything missing.

data[].attributes.colour string

Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52, written in lower case. It is how vaults are told apart at a glance, and it is decoration: nothing depends on it.

data[].attributes.position integer

Where the vault sits in your list, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in.

data[].attributes.is_default boolean

Whether records land here when nothing says which vault. Exactly one of your vaults is true while you hold a vault at all, and none is while you hold none.

data[].attributes.contact_count integer

How many contacts the vault holds, counting the archived and the partial ones. It is a running count kept as contacts are written down and deleted, rather than something counted when you ask.

data[].attributes.created_at timestamp

When the vault was opened, as a count of seconds since 1970 rather than a written date.

data[].attributes.updated_at timestamp

When its wording last changed, as a count of seconds. Equal to created_at until it first changes.

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 page of the vault in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.

meta object

Where you are in the collection.

meta.page integer

The page this is, counting from 1.

meta.per_page integer

How many one page holds, which is the size that was asked for once it has been brought into the allowed range.

meta.total integer

How many vaults there are in all, not how many are on this page.

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/vaults \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/vaults');
Response 200
{
"data": [
{
"type": "vault",
"id": "9d4f1c2e-7b3a-4f88-9a2d-6c1e5b0f7a31",
"attributes": {
"slug": "dunder-mifflin",
"name": "Dunder Mifflin",
"description": "Everybody at the Scranton branch.",
"colour": "#4f8a49",
"position": 1,
"is_default": true,
"contact_count": 12,
"created_at": 1756252800,
"updated_at": 1756339200
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin",
"web": "https://my.monicahq.com/vaults/dunder-mifflin"
}
},
{
"type": "vault",
"id": "b17c6d40-2e59-4a1b-8f03-5d84e2a9c6f7",
"attributes": {
"slug": "schrute-farms",
"name": "Schrute Farms",
"description": null,
"colour": "#9a6a24",
"position": 2,
"is_default": false,
"contact_count": 3,
"created_at": 1756166400,
"updated_at": 1756166400
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/schrute-farms",
"web": "https://my.monicahq.com/vaults/schrute-farms"
}
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 2
}
}

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