Get Inbox Options

GET /cs-close-api/inbox-receivers

The API includes three essential parameters: status, userId, and id. The status parameter accepts string values from the enumeration ACTIVE, INACTIVE and DISABLED enabling users to filter and work with inboxes based on their operational status.

Query parameters

  • page integer(int32)

    The page define the current page number. It should be positive integer number and should start with minimum value 1.

    Minimum value is 1.

  • size integer(int32)

    The size define number of records on each page. It should be positive integer number between 1 to 10000.

    Minimum value is 1, maximum value is 10000.

  • sort array[string]

    The sort parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.

  • name string

    The name parameter is an optional filter that allows you to narrow down the results based on specific name content.

  • status string

    Filters inbox receivers based on their status, which can be ACTIVE, INACTIVE and DISABLED.

  • userId string

    Filters inbox receivers by the associated user's ID.

  • id string

    Filters inbox receivers by their unique identifier.

Responses

  • 200 application/json

    The requested page of entities.

    Hide response attributes Show response attributes object
    • result array[object]
      Hide result attributes Show result attributes object
    • metadata object

      Paging metadata dto.

      Hide metadata attributes Show metadata attributes object
      • totalElements integer(int64)

        The total number of rows in the result set.

      • totalPages integer(int32)

        The total number of pages in the result set, should = totalElements / size

      • first boolean

        True if this is the first page.

      • last boolean

        True if this is the last page.

      • empty boolean

        True if the result is empty.

      • numberOfElements integer(int32)

        The number of results in this page. Will be <= size.

      • size integer(int32)

        The page size.

      • sorted boolean

        True if the results are sorted.
GET /cs-close-api/inbox-receivers 
curl \
 --request GET 'http://close-service:8082/cs-close-api/inbox-receivers'
Response examples (200) 
{
  "result": [
    {
      "id": 23,
      "name": "77256 - remove user from queue"
    }
  ],
  "metadata": {
    "totalElements": 42,
    "totalPages": 42,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 42,
    "size": 42,
    "sorted": true
  }
}