API v1
v1
View as Markdown

Get a relationship

GET /api/v1/vaults/{vault}/contacts/{contact}/relationships/{relationship}

Retrieve one relationship through either of its two people.

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.

vault string Required

The vault both people live in, named either by the readable name it reports as slug or by its id.

contact string Required

One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.

relationship uuid Required

The id of the relationship. It is reached through either of its two people, and through anybody else answers 404.

Returns

A relationship object.

data object

The relationship.

data.type string

Always relationship. 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.relationship_type object

What the link is.

data.attributes.relationship_type.id uuid

The id of the relationship type.

data.attributes.relationship_type.name string

The name of the relationship type.

data.attributes.relationship_type.is_symmetric boolean

True when both people hold the same role, as partners do.

data.attributes.contact_a object

The person holding role_a.

data.attributes.contact_a.id uuid

The id of the contact.

data.attributes.contact_a.slug string

The readable name of the contact, which addresses it as well as its id.

data.attributes.contact_a.name string

The name of the contact, as it is shown.

data.attributes.contact_a.is_partial boolean

True for somebody who exists only through a relationship and has no record of their own.

data.attributes.contact_a.role string

The role this person holds, which is the type's role_a.

data.attributes.contact_b object

The person holding role_b.

data.attributes.contact_b.id uuid

The id of the contact.

data.attributes.contact_b.slug string

The readable name of the contact, which addresses it as well as its id.

data.attributes.contact_b.name string

The name of the contact, as it is shown.

data.attributes.contact_b.is_partial boolean

True for somebody who exists only through a relationship and has no record of their own.

data.attributes.contact_b.role string

The role this person holds, which is the type's role_b.

data.attributes.status string

current or ended.

data.attributes.started_on string

When it started, written as a year, a month and a day, or null.

data.attributes.ended_on string

When it ended, or null. Always null while the relationship is current.

data.attributes.created_at timestamp

When the relationship was recorded, as a count of seconds since 1970.

data.attributes.updated_at timestamp

When it 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.

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/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185 \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185');
Response 200
{
"data": {
"type": "relationship",
"id": "7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185",
"attributes": {
"relationship_type": {
"id": "b52f0d7e-1c84-4a39-9e6b-3f7a20c5d816",
"name": "Partner",
"is_symmetric": true
},
"contact_a": {
"id": "2d6b8f13-9a07-4c5e-b1f4-6e3a90d2c748",
"slug": "jim-halpert",
"name": "Jim Halpert",
"is_partial": false,
"role": "partner"
},
"contact_b": {
"id": "e8a41c06-7f25-4b93-8d0e-52c9b7f1a364",
"slug": "pam-beesly",
"name": "Pam Beesly",
"is_partial": false,
"role": "partner"
},
"status": "current",
"started_on": "2007-05-10",
"ended_on": null,
"created_at": 1790380800,
"updated_at": 1790380800
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/jim-halpert/relationships/7c1e9a42-5b3d-4f60-a8e2-0d94b6c3f185"
}
}
}

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