---
title: GET Statements
slug: get-statements
icon: 🟦
createdAt: 2022-03-23T01:39:56.000Z
---

To get pending statement information, call GET on the pending statement endpoint with your private key from your server and a few request parameters.

We use pagination in the backend, with a maximum limit of 100

The search query param uses RSQL with the following keys:

&#x20;NOTE: To use AND or OR filters, delimit your search parameters using ";" for Logical AND, and "," for Logical OR

| Operator | Definition             | Example                        |
| -------- | ---------------------- | ------------------------------ |
| ==       | Equals                 | status==Pending                |
| !=       | Not Equals             | status!=Failed                 |
| =gt=     | Greater Than           | amountDue=gt=0                 |
| =ge=     | Greater Than Or Equals | amountDue=ge=0                 |
| =lt=     | Less Than              | amountDue=lt=100000            |
| =le=     | Less Than Or Equals    | amountDue=le=100000            |
| =in=     | In                     | status=in=(Pending,InProgress) |
| =out=    | Not In                 | status=out=(Failed)            |

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://gfp-api.acdev.io/api/v1/pending-invoices/search",
  "name": "GET Pending Invoices",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "kind": "required",
        "name": "limit",
        "type": "string",
        "children": [],
        "description": "Number of items per page to be returned"
      },
      {
        "kind": "required",
        "name": "offset",
        "type": "string",
        "children": [],
        "description": "Page Number.  e.g. 0 for first 100 items if limit is 100, 1 for next 100 items, etc"
      },
      {
        "kind": "required",
        "name": "sort",
        "type": "string",
        "children": [],
        "description": "Sort Parameters. \ne.g. sort=-updatedDt"
      },
      {
        "kind": "required",
        "name": "filter",
        "type": "string",
        "children": [],
        "description": "Search Parmeters.  Use the RSQL query with the parameters above\ne.g. filter=status=in=(Pending,InProgress);amountDue=ge=0"
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "pMInQ8C-M98C_slP9_W4z",
        "code": "{\n    \"entities\": [\n        {\n            \"id\": \"01H3JK407G9SBRGSJ1ZRW7V93T\",\n            \"storeId\": \"01GDG5BZA29R3SZMZ63Y2GFENV\",\n            \"amountDue\": 15780,\n            \"plannedExecutionDt\": \"2023-06-22T18:20:39.476145\",\n            \"email\": \"the.white.wolf@winterfell.com\",\n            \"smsPhoneNumber\": \"+15556873509\",\n            \"firstName\": \"John\",\n            \"lastName\": \"Snow\",\n            \"internalPatientId\": \"01H3JK403F9MPS8H79CTHR1RQC\",\n            \"externalPatientId\": \"2006-1000009\",\n            \"fileName\": \"test_upload.xlsx\",\n            \"createdBy\": \"admin@localhost.com\",\n            \"createdDt\": \"2023-06-22T18:20:39.536412\",\n            \"updatedDt\": \"2023-06-22T18:20:39.536422\",\n            \"sendEmail\": true,\n            \"sendText\": true,\n            \"sendPaper\": false,\n            \"ableToSendEmail\": true,\n            \"ableToSendText\": true,\n            \"ableToSendPaper\": true,\n            \"warnings\": [],\n            \"errors\": [],\n            \"status\": \"Pending\"\n        }\n    ],\n    \"currentPage\": 0,\n    \"totalItems\": 1,\n    \"totalPages\": 1\n    }",
        "language": "200",
        "customLabel": ""
      },
      {
        "id": "lmm_9BHz550F6VSpLNskH",
        "code": "{\n  \"subErrors\":[],\n  \"status\":\"BAD_REQUEST\",\n  \"message\":\"Could not find store for: orders id: 01FYWBXKKH8DX8MFBZ37VMYVA1\"\n}",
        "language": "400",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "pMInQ8C-M98C_slP9_W4z"
  },
  "examples": {
    "languages": [
      {
        "id": "i5pMfxvJ3c4YYX32197Il",
        "code": "curl --request GET \\\n  --url 'https://test-api.featherpay.io/api/v1/pending-invoices/search?filter=status%3Din%3D(Pending)&sort=-updatedDt&limit=10&offset=0' \\\n  --header 'content-type: application/json;charset=UTF-8' \\\n  --header 'accept: application/json' \\\n  --header 'X-Api-Key: {Secret API Key}' \\\n  --header 'X-Store-Id: {Store ULID}'",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "i5pMfxvJ3c4YYX32197Il"
  },
  "description": "Get Pending Invoices by Query",
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::





Response

:::CodeblockTabs
json

```json
{
  "currentPage": 0 //current Page of pagination.  Should equal offset
  "totalItem": 110 //Total Items that match the query
  "totalPages": 10 // Will be the total pages needed to paginate to get all items
  "entities": [] //Array of the entities to be returned. 
}
```
:::

