Skip to main content
GET
/
api
/
public
/
v1
/
requests
List Requests Jsonapi
curl --request GET \
  --url https://api.example.com/api/public/v1/requests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "attributes": {
        "request_id": "<string>",
        "requested_by": "<string>",
        "status": "PENDING",
        "note_id": "<string>",
        "community_server_id": "<string>",
        "requested_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "content": "<string>",
        "platform_message_id": "<string>",
        "platform_channel_id": "<string>",
        "metadata": {},
        "similarity_score": 123,
        "dataset_name": "<string>",
        "dataset_item_id": "<string>"
      },
      "type": "requests"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "self_": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next_": "<string>",
    "describedby": "<string>"
  },
  "meta": {
    "count": 123,
    "page": 123,
    "pages": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Query Parameters

page[number]
integer
default:1
Required range: x >= 1
page[size]
integer
default:20
Required range: 1 <= x <= 100
filter[status]
enum<string> | null
Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED
filter[community_server_id]
string<uuid> | null
filter[requested_by]
string | null
filter[requested_at__gte]
string<date-time> | null
filter[requested_at__lte]
string<date-time> | null

Response

Successful Response

JSON:API response for a list of request resources.

data
RequestResource · object[]
required
jsonapi
Jsonapi · object

JSON:API links object for pagination and resource links.

Uses field aliases for 'self' and 'next' which are Python reserved words. Always use by_alias=True when serializing. Includes JSON:API 1.1 'describedby' link for API documentation.

meta
JSONAPIMeta · object

JSON:API meta object for pagination and collection metadata.