Collectionscreate is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
{
"operationId": "collectionsCreate",
"path": "/collections.create",
"method": "POST",
"summary": "Create a collection",
"tags": [
"Collections"
],
"requestSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Human Resources"
},
"description": {
"type": "string",
"description": "A brief description of the collection, markdown supported. Only one of `description` or `data` may be provided.",
"example": "HR documentation is confidential and should be handled with care."
},
"data": {
"type": "object",
"description": "The collection description as a rich-text ProseMirror JSON document. Only one of `description` or `data` may be provided."
},
"permission": {
"$ref": "#/components/schemas/Permission"
},
"icon": {
"type": "string",
"description": "A string that represents an icon in the outline-icons package or an emoji"
},
"color": {
"type": "string",
"description": "A hex color code for the collection icon",
"example": "#123123"
},
"sharing": {
"type": "boolean",
"description": "Whether public sharing of documents is allowed",
"example": false
}
},
"required": [
"name"
]
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.