List requests

HOM

https://hom.roit.ai

GET

/roit-data-integration/v1/requests/list

Retrieves a list of requests with pagination support

Request

Query Params

limit

integer

Limit

optional

Maximum number of requests to return

>= 1<= 1000

Default:

100

Example:

100

page_size

integer

Page Size

optional

Number of requests per page

>= 1<= 100

Default:

Example:

start_after

string

Start After

optional

Document ID to start after for pagination

Example:

bb0c892a-9695-414d-966b-c3cd66959067

Header Params

Authorization

string

required

token generated

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://hom.roit.ai/roit-data-integration/v1/requests/list' \
--header 'Authorization;'

Responses

🟢200OK

application/json

List of requests retrieved successfully

Body

status_code

integer

Status Code

optional

>= 200<= 599

Default:

200

message

string

Message

optional

Default:

data

object

Data

optional

List of requests with pagination

requests

array[object (RequestItem) {7}]

Requests

required

List of requests

pagination

object

Pagination

required

Pagination information

error

object

Error

optional

Error message

status

string

Status

optional

Default:

success

Example

{
    "status": "success",
    "message": "Requests retrieved successfully",
    "data": {
        "requests": [
            {
                "processUniqueId": "bb0c892a-9695-414d-966b-c3cd66959067",
                "processStatus": "PENDING",
                "callbackUrl": "https://api.example.com/webhook/status-update",
                "operationType": "DOCUMENT_PROCESSING",
                "documentType": "NFE",
                "createdAt": "2024-01-15T10:30:00Z",
                "updatedAt": "2024-01-15T10:30:00Z"
            },
            {
                "processUniqueId": "c7865b7c-78d4-4117-98f7-00d918eda49f",
                "processStatus": "PROCESSING",
                "callbackUrl": "https://api.example.com/webhook/status-update",
                "operationType": "DOCUMENT_PROCESSING",
                "documentType": "NFSE",
                "createdAt": "2024-01-15T09:15:00Z",
                "updatedAt": "2024-01-15T11:00:00Z"
            }
        ],
        "pagination": {
            "limit": 100,
            "pageSize": 50,
            "hasMore": true,
            "nextCursor": "c7865b7c-78d4-4117-98f7-00d918eda49f"
        }
    }
}

🔴500Server Error

Modified at 2025-07-15 18:38:21

Update request status

Get request by ID