Get a type
Returns a type's schema, with the fields and policies it inherits from its ancestors. Every credential reads any type, whatever its type map reaches.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe identifier of the type, such as core.note.
Returns the type.
application/json- response
A type says which fields the items of that type hold, and what else Marfa does for them.
id*stringUnique identifier for the type.
label?stringThe type's name for people to read.
plural*stringThe type's plural name for people to read, such as People: the one the type declares, else one made from its label. Never inherited.
description?stringWhat the type is for.
parent?stringThe identifier of the type this one inherits from.
compatible_with?array<string>The types this one is a structural superset of.
roles?array<>The structural roles the type plays, including those it inherits.
fields*The type's own fields, by name. GET /types/{id} adds the fields it inherits.
tables?The type's own tables, by name. GET /types/{id} adds the tables it inherits.
version*integerThe version number the type was last saved with.
0 <= valuedisplay_hints?How clients show the type and its items: the title field, the body field, whether the body names an item, and the icon.
link_field?stringThe name of a string field, declared or inherited, that holds each item's own ID at the vendor that writes the type. No two items of the type, in any state, hold the same value. A subtype names its own link. The name has no " or \.
version_policy?How long Marfa keeps the versions of the type's items.
merge_policy?How Marfa merges conflicting edits to the type's items.
retention_policy?How long Marfa keeps the type's items in the feed tier.
provenance*The type's recorded origin and creator.
validation_error: the query has a parameter this endpoint doesn't take.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
type_not_found: no type has this identifier.
application/json- response
An error response.
error*What went wrong.
type_chain_unresolvable: the type's stored definition does not read. PUT /types/{id} can correct it.
application/json- response
An error response.
error*What went wrong.
contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.
application/json- response
An error response.
error*What went wrong.
rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.
application/json- response
An error response.
error*What went wrong.
internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.
application/json- response
An error response.
error*What went wrong.
write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.
application/json- response
An error response.
error*What went wrong.
insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.
application/json- response
An error response.
error*What went wrong.
curl -X GET 'http://localhost:8600/types/string'{ "id": "acme.deal", "version": 0, "fields": { "name": { "type": "string", "label": "Name", "required": true }, "amount": { "type": "number", "label": "Amount" }, "stage": { "type": "enum", "label": "Stage", "enum_values": [ "lead", "won", "lost" ] } }, "label": "Deal", "plural": "Deals", "description": "A sales deal.", "display_hints": { "title_field": "name" }, "provenance": { "origin": "user", "created_by": { "kind": "key", "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4", "name": "CRM sync" } }}