Request a library share

POST

api

library

Request a new org-library share

curl --request POST \
  --url https://abacusdocs.com/api/v2/library/shares/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object_id": 2,
  "note": "<string>"
}
'

import requests

url = "https://abacusdocs.com/api/v2/library/shares/"

payload = {
    "object_id": 2,
    "note": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({object_id: 2, note: '<string>'})
};

fetch('https://abacusdocs.com/api/v2/library/shares/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 123,
  "content_type": "<string>",
  "object_id": 123,
  "content_object_summary": {
    "id": 123,
    "kind": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "status": "<string>"
  },
  "state": "pending",
  "shared_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_at": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{}

{}

{}

{
  "id": 123,
  "content_type": "<string>",
  "object_id": 123,
  "content_object_summary": {
    "id": 123,
    "kind": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "status": "<string>"
  },
  "state": "pending",
  "shared_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_at": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Owner requests org-wide visibility. Mods auto-approve. 409 if a non-terminal share already exists for that item.

Authorizations

Authorization

string

header

required

Organisation API key from Settings → API / /api/keys/. The secret is shown once. Send Authorization: Bearer sk-abacus-…. One active key per organisation. Ingest (/api/v2/ingest/*) refuses API keys — that surface is Auth0-only with ingest:read / ingest:write scopes.

Body

application/json

Input for POST /api/v2/library/shares/.

The view resolves (content_type, object_id) to a concrete Struct or Batch instance and enforces org-match + ownership-or-mod before inserting the share row. This serializer just validates input shape.

content_type

enum<string>

required

struct - struct
batch - batch

Available options:

struct,

batch

object_id

integer

required

Required range: x >= 1

note

string

Maximum string length: 500

Response

Output projection for an OrgLibraryShare row.

Composed for both the list endpoint and as the response body of every mutation endpoint, so the SPA can re-render the row from a POST response without a follow-up GET. content_object_summary is computed via SerializerMethodField because the underlying target is a generic FK — a normal nested serializer doesn't fit.

integer

required

read-only

content_type

string

required

read-only

object_id

integer

required

read-only

content_object_summary

object | null

required

Tiny shape: just enough to render a share row in the UI.

For Struct rows: {"id", "slug", "name", "status"} (slug is the SPA-routing key). For Batch rows: {"id", "name", "status"}. kind distinguishes them when the SPA wants a single discriminator field; it mirrors content_type.model.

Show child attributes

state

enum<string>

required

pending - Pending
approved - Approved
rejected - Rejected
revoked - Revoked
kicked - Kicked

Available options:

pending,

approved,

rejected,

revoked,

kicked

shared_by

object | null

required

Compact user projection for shared_by / decided_by fields.

Show child attributes

decided_by

object | null

required

Compact user projection for shared_by / decided_by fields.

Show child attributes

decided_at

string<date-time> | null

required

read-only

note

string

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

Request a new org-library share

curl --request POST \
  --url https://abacusdocs.com/api/v2/library/shares/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object_id": 2,
  "note": "<string>"
}
'

import requests

url = "https://abacusdocs.com/api/v2/library/shares/"

payload = {
    "object_id": 2,
    "note": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({object_id: 2, note: '<string>'})
};

fetch('https://abacusdocs.com/api/v2/library/shares/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": 123,
  "content_type": "<string>",
  "object_id": 123,
  "content_object_summary": {
    "id": 123,
    "kind": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "status": "<string>"
  },
  "state": "pending",
  "shared_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_at": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{}

{}

{}

{
  "id": 123,
  "content_type": "<string>",
  "object_id": 123,
  "content_object_summary": {
    "id": 123,
    "kind": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "status": "<string>"
  },
  "state": "pending",
  "shared_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_by": {
    "id": 123,
    "email": "jsmith@example.com"
  },
  "decided_at": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Overview

Documents

Schemas

Batches

Chats

Notifications

Ingest

Sharing

Request a library share

Authorizations

Body

Response