Skip to main content
GET
/
requests
List created requests
curl --request GET \
  --url https://requests.prod.judit.io/requests \
  --header 'api-key: <api-key>'
{
    "page": 1,
    "page_data": [
        {
            "request_id": "00000000-0000-0000-0000-000000000001",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b1",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "pending",
            "created_at": "2023-10-05T17:59:11.234Z",
            "updated_at": "2023-10-05T17:59:11.234Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000002",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b2",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:12:36.331Z",
            "updated_at": "2023-10-05T18:14:12.867Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000003",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b3",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:13:28.266Z",
            "updated_at": "2023-10-05T18:13:39.988Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000004",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b4",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:15:07.209Z",
            "updated_at": "2023-10-05T18:15:08.187Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000005",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b5",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:15:20.042Z",
            "updated_at": "2023-10-05T18:15:20.407Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000006",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b6",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:19:49.285Z",
            "updated_at": "2023-10-05T18:19:50.226Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000007",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b7",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:26:59.283Z",
            "updated_at": "2023-10-05T18:27:03.765Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000008",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b8",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:28:34.028Z",
            "updated_at": "2023-10-05T18:29:48.945Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000009",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b9",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:44:05.048Z",
            "updated_at": "2023-10-05T18:44:19.251Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000010",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000c0",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:56:40.807Z",
            "updated_at": "2023-10-05T18:56:55.340Z"
        }
    ],
    "page_count": 10,
    "all_count": 47,
    "all_pages_count": 5
}
​
page
integer
Defines which page of results you want to fetch.
​
page_size
integer
Defines the maximum number of results you want to receive per page.
​
orderField
string
Name of the field to sort the requests by.
​
orderDirection
string
Sort direction: ‘asc’ or ‘desc’.
​
search_type
string
Returns requests of the specified reference type: ‘cpf’, ‘cnpj’, ‘oab’, or ‘lawsuit_cnj’.
​
search_key
string
Returns requests related to the provided CPF, CNPJ, OAB, or lawsuit number.
​
lawsuit_instance
integer
Returns requests whose lawsuit instance matches the one provided.
​
origin
string
Returns requests whose origin matches the one provided — can be ‘tracking’ or ‘api’.
​
origin_id
string
Returns requests related to the origin ID, which can be a tracking_id (the ID of a tracking) or an ID generated by the API.
​
status
string
Returns requests whose status is one of ‘created’, ‘pending’, ‘started’, ‘cancelling’, ‘cancelled’, or ‘completed’. You may also pass more than one status as an array (e.g., ['started', 'completed']).
​
distribution_date_gte
date
Returns requests whose distribution date is greater than or equal to the value provided.
​
created_at_gte
date
Returns requests whose creation date is greater than or equal to the value provided.
​
created_at_lte
date
Returns requests whose creation date is less than or equal to the value provided.
​
updated_at_gte
date
Returns requests whose update date is greater than or equal to the value provided.
​
updated_at_lte
date
Returns requests whose update date is less than or equal to the value provided.
​
started_at_gte
date
Returns requests whose execution start date is greater than or equal to the value provided.
​
started_at_lte
date
Returns requests whose execution start date is less than or equal to the value provided.
​
cancelled_at_gte
date
Returns requests whose cancellation date is greater than or equal to the value provided.
​
cancelled_at_lte
date
Returns requests whose cancellation date is less than or equal to the value provided.
​
completed_at_gte
date
Returns requests whose completion date is greater than or equal to the value provided.
​
completed_at_lte
date
Returns requests whose completion date is less than or equal to the value provided.
{
    "page": 1,
    "page_data": [
        {
            "request_id": "00000000-0000-0000-0000-000000000001",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b1",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "pending",
            "created_at": "2023-10-05T17:59:11.234Z",
            "updated_at": "2023-10-05T17:59:11.234Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000002",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b2",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:12:36.331Z",
            "updated_at": "2023-10-05T18:14:12.867Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000003",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b3",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:13:28.266Z",
            "updated_at": "2023-10-05T18:13:39.988Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000004",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b4",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:15:07.209Z",
            "updated_at": "2023-10-05T18:15:08.187Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000005",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b5",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:15:20.042Z",
            "updated_at": "2023-10-05T18:15:20.407Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000006",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b6",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:19:49.285Z",
            "updated_at": "2023-10-05T18:19:50.226Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000007",
            "search": {
                "search_type": "lawsuit_cnj",
                "search_key": "9999999-99.9999.9.99.9999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b7",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:26:59.283Z",
            "updated_at": "2023-10-05T18:27:03.765Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000008",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b8",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:28:34.028Z",
            "updated_at": "2023-10-05T18:29:48.945Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000009",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000b9",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:44:05.048Z",
            "updated_at": "2023-10-05T18:44:19.251Z"
        },
        {
            "request_id": "00000000-0000-0000-0000-000000000010",
            "search": {
                "search_type": "cpf",
                "search_key": "99999999999",
                "search_params": {}
            },
            "origin": "api",
            "origin_id": "00000000-0000-0000-0000-0000000000c0",
            "user_id": "00000000-0000-0000-0000-0000000000aa",
            "status": "completed",
            "created_at": "2023-10-05T18:56:40.807Z",
            "updated_at": "2023-10-05T18:56:55.340Z"
        }
    ],
    "page_count": 10,
    "all_count": 47,
    "all_pages_count": 5
}

Authorizations

​
api-key
string
header
required

Query Parameters

​
page
integer

Defines which page of results you want to fetch.

​
page_size
integer

Defines the maximum number of results you want to receive per page.

​
orderField
string

Name of the field to sort the requests by.

​
orderDirection
string

Sort direction: ‘asc’ or ‘desc’.

​
search_type
string

Returns requests of the specified reference type: ‘cpf’, ‘cnpj’, ‘oab’, or ‘lawsuit_cnj’.

​
search_key
string

Returns requests related to the provided CPF, CNPJ, OAB, or lawsuit number.

​
lawsuit_instance
integer

Returns requests whose lawsuit instance matches the one provided.

​
origin
string

Returns requests whose origin matches the one provided — can be ‘tracking’ or ‘api’.

​
origin_id
string

Returns requests related to the origin ID, which can be a tracking_id (the ID of a tracking) or an ID generated by the API.

​
status
string

Returns requests whose status is one of ‘created’, ‘pending’, ‘started’, ‘cancelling’, ‘cancelled’, or ‘completed’. You may also pass more than one status as an array (e.g., ['started', 'completed'] ).

​
distribution_date_gte
string

Returns requests whose distribution date is greater than or equal to the value provided.

​
created_at_gte
string

Returns requests whose creation date is greater than or equal to the value provided.

​
created_at_lte
string

Returns requests whose creation date is less than or equal to the value provided.

​
updated_at_gte
string

Returns requests whose update date is greater than or equal to the value provided.

​
updated_at_lte
string

Returns requests whose update date is less than or equal to the value provided.

​
started_at_gte
string

Returns requests whose execution start date is greater than or equal to the value provided.

​
started_at_lte
string

Returns requests whose execution start date is less than or equal to the value provided.

​
cancelled_at_gte
string

Returns requests whose cancellation date is greater than or equal to the value provided.

​
cancelled_at_lte
string

Returns requests whose cancellation date is less than or equal to the value provided.

​
completed_at_gte
string

Returns requests whose completion date is greater than or equal to the value provided.

​
completed_at_lte
string

Returns requests whose completion date is less than or equal to the value provided.