Dust Identity Sharing API

The Sharing API from Dust Identity — 4 operation(s) for sharing.

Operations 6

GET /api/v1/sharing List sharing relationships #
POST /api/v1/sharing Share a bundle or thread #
DELETE /api/v1/sharing Remove sharing relationships #
GET /api/v1/sharing/access-summary Effective access summary for a thread or bundle #
GET /api/v1/sharing/partner-inventory Per-partner sharing inventory #
PATCH /api/v1/sharing/{tuple_id} Update a sharing relationship #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dust-identity-sharing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dust-identity-sharing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: DUST Sharing API
  description: DUST Platform API
  version: 2026.7.4
servers:
- url: https://apid.dustid.io
  description: DUST API for trusted provenance.
security:
- Bearer: []
tags:
- name: Sharing
paths:
  /api/v1/sharing:
    get:
      operationId: sharing.list
      parameters:
      - in: query
        name: direction
        schema:
          enum:
          - in
          - out
        required: true
      - in: query
        name: objectId
        schema:
          anyOf:
          - type: string
            description: a UUID
            format: uuid
            pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
          - const: 00000000-0000-0000-0000-000000000000
            description: a UUID
            format: uuid
          - const: ffffffff-ffff-ffff-ffff-ffffffffffff
            description: a UUID
            format: uuid
          format: uuid
        description: a UUID
      - in: query
        name: objectType
        schema:
          enum:
          - bundle
          - thread
      - in: query
        name: pageIndex
        schema:
          anyOf:
          - type: number
          - type: string
            pattern: ^(?:(?!^-0\.?0*$)(?:-?(?:(?:0|[1-9]\d*)(?:\.\d+)?)|\.\d+?))$
      - in: query
        name: pageSize
        schema:
          anyOf:
          - type: number
          - type: string
            pattern: ^(?:(?!^-0\.?0*$)(?:-?(?:(?:0|[1-9]\d*)(?:\.\d+)?)|\.\d+?))$
      - in: query
        name: q
        schema:
          type: string
      summary: List sharing relationships
      description: List items shared with the active team or items the active team has shared, based on the requested direction.
      tags:
      - Sharing
      responses:
        '200':
          description: List of sharing relationships matching the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTuplesResponse'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: INVALID_REQUEST
                  message:
                    type: string
                  status:
                    const: 400
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: UNAUTHORIZED
                  message:
                    type: string
                  status:
                    const: 401
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
    post:
      operationId: sharing.add
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareRequest'
      summary: Share a bundle or thread
      description: Create one or more sharing relationships for the requested threads or bundles.
      tags:
      - Sharing
      responses:
        '200':
          description: Sharing relationships created successfully
          content:
            application/json:
              schema:
                type: boolean
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: INVALID_REQUEST
                  message:
                    type: string
                  status:
                    const: 400
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: UNAUTHORIZED
                  message:
                    type: string
                  status:
                    const: 401
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: FORBIDDEN
                  message:
                    type: string
                  status:
                    const: 403
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
    delete:
      operationId: sharing.remove
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareRemoveRequest'
      summary: Remove sharing relationships
      description: Delete one or more existing sharing tuples by ID.
      tags:
      - Sharing
      responses:
        '200':
          description: Sharing relationships removed successfully
          content:
            application/json:
              schema:
                type: boolean
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: INVALID_REQUEST
                  message:
                    type: string
                  status:
                    const: 400
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: UNAUTHORIZED
                  message:
                    type: string
                  status:
                    const: 401
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: FORBIDDEN
                  message:
                    type: string
                  status:
                    const: 403
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
  /api/v1/sharing/access-summary:
    get:
      operationId: sharing.access_summary
      parameters:
      - in: query
        name: objectId
        schema:
          anyOf:
          - type: string
            description: a UUID
            format: uuid
            pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
          - const: 00000000-0000-0000-0000-000000000000
            description: a UUID
            format: uuid
          - const: ffffffff-ffff-ffff-ffff-ffffffffffff
            description: a UUID
            format: uuid
          format: uuid
        required: true
        description: a UUID
      - in: query
        name: objectType
        schema:
          enum:
          - bundle
          - thread
        required: true
      summary: Effective access summary for a thread or bundle
      description: 'List every team that can access the item, attributing each grant to its source: owner, a direct share, or access inherited from an ancestor folder.'
      tags:
      - Sharing
      responses:
        '200':
          description: Effective access summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessSummaryResponse'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: INVALID_REQUEST
                  message:
                    type: string
                  status:
                    const: 400
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: UNAUTHORIZED
                  message:
                    type: string
                  status:
                    const: 401
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: FORBIDDEN
                  message:
                    type: string
                  status:
                    const: 403
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
  /api/v1/sharing/partner-inventory:
    get:
      operationId: sharing.partner_inventory
      parameters:
      - in: query
        name: teamId
        schema:
          anyOf:
          - type: string
            description: a UUID
            format: uuid
            pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
          - const: 00000000-0000-0000-0000-000000000000
            description: a UUID
            format: uuid
          - const: ffffffff-ffff-ffff-ffff-ffffffffffff
            description: a UUID
            format: uuid
          format: uuid
        required: true
        description: a UUID
      summary: Per-partner sharing inventory
      description: List every share grant between the active team and the given partner team in both directions — including grants suspended by a paused connection — with counts and the number of in-flight transfers between the pair.
      tags:
      - Sharing
      responses:
        '200':
          description: Sharing inventory for the partner team
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerInventoryResponse'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: INVALID_REQUEST
                  message:
                    type: string
                  status:
                    const: 400
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: UNAUTHORIZED
                  message:
                    type: string
                  status:
                    const: 401
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: FORBIDDEN
                  message:
                    type: string
                  status:
                    const: 403
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
  /api/v1/sharing/{tuple_id}:
    patch:
      operationId: sharing.update
      parameters:
      - in: path
        name: tuple_id
        schema:
          anyOf:
          - type: string
            description: a UUID
            format: uuid
            pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
          - const: 00000000-0000-0000-0000-000000000000
            description: a UUID
            format: uuid
          - const: ffffffff-ffff-ffff-ffff-ffffffffffff
            description: a UUID
            format: uuid
          format: uuid
        required: true
        description: a UUID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareUpdateRequest'
      summary: Update a sharing relationship
      description: Update the relation for an existing sharing tuple.
      tags:
      - Sharing
      responses:
        '200':
          description: Sharing relationship updated successfully
          content:
            application/json:
              schema:
                type: boolean
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: INVALID_REQUEST
                  message:
                    type: string
                  status:
                    const: 400
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: UNAUTHORIZED
                  message:
                    type: string
                  status:
                    const: 401
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    const: FORBIDDEN
                  message:
                    type: string
                  status:
                    const: 403
                  detail:
                    type: object
                    description: Extra context information specific to this error
                required:
                - code
                - message
                - status
components:
  schemas:
    ShareRequest:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                anyOf:
                - type: string
                  description: a UUID
                  format: uuid
                  pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
                - const: 00000000-0000-0000-0000-000000000000
                  description: a UUID
                  format: uuid
                - const: ffffffff-ffff-ffff-ffff-ffffffffffff
                  description: a UUID
                  format: uuid
                description: a UUID
                format: uuid
              item:
                enum:
                - bundle
                - thread
              relation:
                enum:
                - editor
                - viewer
              teamId:
                anyOf:
                - type: string
                  description: a UUID
                  format: uuid
                  pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
                - const: 00000000-0000-0000-0000-000000000000
                  description: a UUID
                  format: uuid
                - const: ffffffff-ffff-ffff-ffff-ffffffffffff
                  description: a UUID
                  format: uuid
                description: a UUID
                format: uuid
            required:
            - id
            - item
            - relation
            - teamId
      required:
      - items
    ShareUpdateRequest:
      type: object
      properties:
        relation:
          enum:
          - admin
          - attached
          - container
          - creator
          - editor
          - member
          - owner
          - parent
          - private
          - protected
          - publish
          - sender
          - share
          - transfer
          - viewer
      required:
      - relation
    ShareRemoveRequest:
      type: object
      properties:
        ids:
          type: array
          description: Sharing instance ids
          items:
            anyOf:
            - type: string
              description: a UUID
              format: uuid
              pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
            - const: 00000000-0000-0000-0000-000000000000
              description: a UUID
              format: uuid
            - const: ffffffff-ffff-ffff-ffff-ffffffffffff
              description: a UUID
              format: uuid
            description: a UUID
            format: uuid
      required:
      - ids
    ListTuplesResponse:
      type: object
      properties:
        total:
          type: number
        tuples:
          type: array
          items:
            anyOf:
            - type: object
              properties:
                bundle:
                  type: object
                  properties:
                    bundleId:
                      type: string
                      description: a RFC-4122-compliant UUID
                      pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                    childOfId:
                      anyOf:
                      - type: string
                        description: a RFC-4122-compliant UUID
                        pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                      - type: 'null'
                    createdAt:
                      type: string
                    description:
                      anyOf:
                      - type: string
                      - type: 'null'
                    kind:
                      type: string
                    name:
                      type: string
                    ownerId:
                      type: string
                      description: a RFC-4122-compliant UUID
                      pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                    updatedAt:
                      type: string
                    depth:
                      type: number
                    hasChildren:
                      type: boolean
                    idPath:
                      type: array
                      items:
                        type: string
                    isSharedOut:
                      type: boolean
                    path:
                      type: array
                      items:
                        type: string
                    permissions:
                      type: object
                      properties:
                        can_edit:
                          type: boolean
                          default: false
                        can_publish:
                          type: boolean
                          default: false
                        can_share:
                          type: boolean
                          default: false
                        can_transfer:
                          type: boolean
                          default: false
                        can_view:
                          type: boolean
                          default: false
                    threadCount:
                      type: number
                  required:
                  - bundleId
                  - childOfId
                  - createdAt
                  - description
                  - kind
                  - name
                  - ownerId
                  - updatedAt
                owner:
                  type: object
                  properties:
                    createdAt:
                      type: string
                    description:
                      anyOf:
                      - type: string
                      - type: 'null'
                    detail:
                      anyOf:
                      - type: string
                      - type: 'null'
                    logo:
                      anyOf:
                      - type: string
                      - type: 'null'
                    name:
                      anyOf:
                      - type: string
                      - type: 'null'
                    orgId:
                      type: string
                      description: a RFC-4122-compliant UUID
                      pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                    teamId:
                      type: string
                      description: a RFC-4122-compliant UUID
                      pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                    updatedAt:
                      type: string
                    depth:
                      type: number
                    num_members:
                      type: number
                    org:
                      type: object
                      properties:
                        name:
                          type: string
                        orgId:
                          type: string
                      required:
                      - name
                      - orgId
                    path:
                      type: string
                  required:
                  - createdAt
                  - description
                  - detail
                  - logo
                  - name
                  - orgId
                  - teamId
                  - updatedAt
                sharedBy:
                  anyOf:
                  - type: object
                    properties:
                      email:
                        type: string
                      name:
                        type: string
                    required:
                    - email
                    - name
                  - type: 'null'
                sharedWith:
                  anyOf:
                  - type: object
                    properties:
                      createdAt:
                        type: string
                      description:
                        anyOf:
                        - type: string
                        - type: 'null'
                      detail:
                        anyOf:
                        - type: string
                        - type: 'null'
                      logo:
                        anyOf:
                        - type: string
                        - type: 'null'
                      name:
                        anyOf:
                        - type: string
                        - type: 'null'
                      org:
                        type: object
                        properties:
                          createdAt:
                            type: string
                          logo:
                            anyOf:
                            - type: string
                            - type: 'null'
                          name:
                            type: string
                          orgId:
                            type: string
                            description: a RFC-4122-compliant UUID
                            pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                          slug:
                            anyOf:
                            - type: string
                            - type: 'null'
                          updatedAt:
                            type: string
                          website:
                            anyOf:
                            - type: string
                            - type: 'null'
                        required:
                        - createdAt
                        - logo
                        - name
                        - orgId
                        - slug
                        - updatedAt
                        - website
                      orgId:
                        type: string
                        description: a RFC-4122-compliant UUID
                        pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                      teamId:
                        type: string
                        description: a RFC-4122-compliant UUID
                        pattern: ^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$
                      updatedAt:
                        type: string
                      depth:
                        type: number
                      num_members:
                        type: number
                      path:
                        type: string
                    required:
                    - createdAt
                    - description
                    - detail
                    - logo
                    - name
                    - org
                    - orgId
                    - teamId
                    - updatedAt
                  - type: 'null'
                tuple:
                  anyOf:
                  - type: object
                    properties:
                      objectId:
                        anyOf:
                        - type: string
                          description: a UUID
                          format: uuid
                          pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
                        - const: 00000000-0000-0000-0000-000000000000
                          description: a UUID
                          format: uuid
                        - const: ffffffff-ffff-ffff-ffff-ffffffffffff
                          description: a UUID
                          format: uuid
                        description: a UUID
                        format: uuid
                      objectType:
                        enum:
                        - actor
                        - bundle
                        - collection
                        - event
                        - field
                        - org
                        - profile
                        - resource
                        - session
                        - team
                        - template
                        - thread
                        - transaction
                        - user
                        - xtag
                      relation:
                        enum:
                        - admin
                        - attached
                        - container
                        - creator
                        - editor
                        - member
                        - owner
                        - parent
                        - private
                        - protected
                        - publish
                        - sender
                        - share
                        - transfer
                        - viewer
                      tupleId:
                        anyOf:
                        - type: string
                          description: a UUID
                          format: uuid
                          pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
                        - const: 00000000-0000-0000-0000-000000000000
                          description: a UUID
                          format: uuid
                        - const: ffffffff-ffff-ffff-ffff-ffffffffffff
                          description: a UUID
                          format: uuid
                        description: a UUID
                        format: uuid
                      userCtxId:
                        anyOf:
                        - type: string
                          description: a UUID
                          format: uuid
                          pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
                        - const: 00000000-0000-0000-0000-000000000000
                          description: a UUID
                          format: uuid
                        - const: ffffffff-ffff-ffff-ffff-ffffffffffff
                          description: a UUID
                          format: uuid
                        description: a UUID
                        format: uuid
                      userId:
                        anyOf:
                        - type: string
                          description: a UUID
                          format: uuid
                          pattern: '[\da-f]{8}-[\da-f]{4}-[1-8][\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}'
                        - const: 00000000-0000-0000-0000-000000000000
                          description: a UUID
                          format: uuid
                        - const: ffffffff-ffff-ffff-ffff-ffffffffffff
                          description: a UUID
                          format: uuid
                        description: a UUID
                        format: uuid
                      userType:
                        const: user
                      condition:
                        anyOf:
                        - type: object
                          properties:
                            name:
                              type: string
                            context:
                              type: object
                          required:
                          - name
                        - type: 'null'
                      dormantCause:
                        anyOf:
                        - const: connection_paused
                        - const: direction_disallowed
                        - type: 'null'
                      objectRelationSpecifier:
                        anyOf:
                        - const: admin
                        - const: attached
                        - const: container
                        - const: creator
                        - const: editor

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dust-identity/refs/heads/main/openapi/dust-identity-sharing-api-openapi.yml