---
title: "Get inbox list"
method: GET
path: "/api/v1/inbox/index"
tags: ["Inbox"]
---

# Get inbox list

`GET /api/v1/inbox/index`

## Query parameters

- `quickFilter` string

## Response `200`

Inbox list response

- union[]
  - union
    - UserRegistrationInbox
      - `id` integer
      - `uuid` string, uuid
      - `scope` 'User' | 'LocalTool' | 'Brood' | 'Proposal' | 'Synchronisation'
      - `action` 'Registration' | 'IncomingConnectionRequest' | 'AcceptedRequest' | 'DeclinedRequest' | 'Synchronisation' | 'OneWaySynchronization' | 'ProposalEdit' | 'DataExchange'
      - `title` string
      - `origin` string
      - `comment` string, nullable
      - `description` string, nullable
      - `user_id` integer
      - `created` string, datetime
      - `modified` string, datetime
      - `data` object
        - `email` string, email
        - `password` string
      - `user` User
        - `id` integer
        - `uuid` string, uuid
        - `username` string
        - `role_id` integer
        - `individual_id` integer
        - `disabled` boolean
        - `created` string, datetime
        - `modified` string, datetime
        - `organisation_id` integer
        - `organisation` Organisation
          - `id` integer
          - `uuid` string, uuid
          - `name` string
          - `url` string
          - `nationality` string, nullable
          - `sector` string, nullable
          - `type` string, nullable
          - `contacts` string, nullable
          - `created` string, datetime
          - `modified` string, datetime
          - `tags` Tag[]
            - `id` integer
            - `name` string
            - `namespace` string, nullable
            - `predicate` string, nullable
            - `value` string, nullable
            - `colour` string
            - `text_colour` string
            - `counter` integer
            - `created` string, datetime
            - `modified` string, datetime
          - `aligments` Alignment[]
        - `individual` Individual
          - `id` integer
          - `uuid` string, uuid
          - `email` string, email
          - `first_name` string
          - `last_name` string
          - `full_name` string
          - `position` string
          - `tags` Tag[]
            - `id` integer
            - `name` string
            - `namespace` string, nullable
            - `predicate` string, nullable
            - `value` string, nullable
            - `colour` string
            - `text_colour` string
            - `counter` integer
            - `created` string, datetime
            - `modified` string, datetime
          - `aligments` Alignment[]
          - `created` string, datetime
          - `modified` string, datetime
        - `role` Role
          - `id` integer
          - `name` string
          - `is_default` boolean
          - `perm_admin` boolean
          - `perm_sync` boolean
          - `perm_org_admin` boolean
      - `local_tool_connector_name` string, nullable
    - IncomingConnectionRequestInbox
      - `id` integer
      - `uuid` string, uuid
      - `scope` 'User' | 'LocalTool' | 'Brood' | 'Proposal' | 'Synchronisation'
      - `action` 'Registration' | 'IncomingConnectionRequest' | 'AcceptedRequest' | 'DeclinedRequest' | 'Synchronisation' | 'OneWaySynchronization' | 'ProposalEdit' | 'DataExchange'
      - `title` string
      - `origin` string
      - `comment` string, nullable
      - `description` string, nullable
      - `user_id` integer
      - `created` string, datetime
      - `modified` string, datetime
      - `data` object
        - `connectorName` 'MispConnector'
        - `cerebrateURL` string
        - `local_tool_id` integer
        - `remote_tool_id` integer

## Other responses

- `403` — Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.
- `405` — Method not allowed. Your User Role is not allowed to access this resource.
- `default` — Unexpected API error

## Changes

- **2022-01-17** `8e8aed2e396b` — 3 info
  - added the optional property `items/anyOf[#/components/schemas/UserRegistrationInbox]/allOf[subschema #2]/user/individual` to the response with the `200` status
  - added the optional property `items/anyOf[#/components/schemas/UserRegistrationInbox]/allOf[subschema #2]/user/organisation` to the response with the `200` status
  - added the optional property `items/anyOf[#/components/schemas/UserRegistrationInbox]/allOf[subschema #2]/user/role` to the response with the `200` status
- **2022-01-13** `d58602d0d5b6` — 14 warning
  - added the new `Brood` enum value to the `items/anyOf[#/components/schemas/IncomingConnectionRequestInbox]/allOf[#/components/schemas/Inbox]/scope` response property for the response status `200`
  - added the new `Brood` enum value to the `items/anyOf[#/components/schemas/UserRegistrationInbox]/allOf[#/components/schemas/Inbox]/scope` response property for the response status `200`
  - added the new `DataExchange` enum value to the `items/anyOf[#/components/schemas/IncomingConnectionRequestInbox]/allOf[#/components/schemas/Inbox]/action` response property for the response status `200`
  - added the new `DataExchange` enum value to the `items/anyOf[#/components/schemas/UserRegistrationInbox]/allOf[#/components/schemas/Inbox]/action` response property for the response status `200`
  - …10 more
- **2022-01-13** `e3d69e621c4d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/changes/api/v1/inbox/index/get.md)

---

[API](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api.md) · [All operations](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/revisions/90789d145645?raw)