List Closing Notes

GET

/space/closing_notes

curl --request GET \
  --url 'https://api.aelyst.ai/v1/space/closing_notes?limit=10' \
  --header 'Authorization: Bearer <token>'

• Production

Get a list of all the closing notes in the workspace.

The response is sorted by category.

Authorizations

• BearerAuth

Parameters

Query Parameters

limit

integer

default: 10 >= 1 < 100 >= 1 characters <= 100 characters

Number of items to return i.e. page size.

cursorId

integer

Pointer to the contact id from where the next batch of records should start from.

Responses

200

Media typeapplication/json

object

items

Array<object>

object

category

required

The name of category you have created.

string

description

string

pagination

object

next

required

string

previous

required

string

Example

{
  "items": [
    {
      "category": "Order Issue",
      "description": "Conversation dealt with issues related to a specific order."
    }
  ],
  "pagination": {
    "next": "https://api.aelyst.ai/space/closing_notes?limit=10&cursorId=10",
    "previous": "https://api.aelyst.ai/space/closing_notes?limit=10&cursorId=-10"
  }
}

400

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

1

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

10

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

5

Number of request remaining for this end point

500

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}