> For the complete documentation index, see [llms.txt](https://docs.quantumbyte.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.quantumbyte.ai/home/quantumbyte-v2.0/2.builder/3.integrasi/api-formulir/4.read.md).

# Read Data

Untuk melakukan Read Data melalui API masuk ke tab-menu Integrasi API.

Pada bidang integrasi API pilih/klik '\[GET] /list' seperti gambar berikut ini :

<figure><img src="/files/dGYiPEuAgoB4oSMIfWaI" alt=""><figcaption></figcaption></figure>

Akan muncul informasi dokumentasi penggunaan Endpoint '\[GET] /list'

Berikut adalah penjelasan dari setiap bagian:

**- Methods:** Hanya dapat diakses menggunakan metode GET.

**- Headers:** Memerlukan dua header, yaitu 'access\_key' dan 'app\_key', yang harus disertakan dengan nilai kunci akses masing-masing.

**- Info:** Menyertakan informasi tambahan seperti ID formulir (formId) dan ID aplikasi (appId).

**- Url:** Struktur URL untuk mengakses endpoint ini, termasuk placeholder untuk 'base\_url', 'appId', dan 'formId'.

**- Filter** (opsional): Filter data yang opsional, dengan contoh filter dapat dilihat di Catatan Skema filter.

**- Sort (opsional):** Pengurutan data yang opsional, dengan contoh pengurutan dapat dilihat di Catatan Skema sort.

**- Search (opsional):** Pencarian data yang opsional, dalam contoh ini, ditentukan bahwa query pencarian adalah "\*".

**- Pagination (opsional):** Pengaturan halaman yang opsional, memungkinkan untuk mengatur baris awal dan akhir untuk membatasi jumlah data yang dikembalikan.

Berikut adalah contoh penggunaan skema filter

```json
{
  "nama_field":
  {
    "filterType":"text",
    "type":"equals",
    "filter":"filter_value"
  }
} 
```

nama\_field = field pada formulir, list nama field dapat di lihat di "Daftar Semua Fields"

filterType = jenis filter data dapat berupa (text/number/date/set)

type = mode filter berdasarkan dengan jenis filter:

```
jika filterType (text) maka type (exists/notExists/equals/notEqual/contains/notContains/startsWith/endsWith)
jika filterType (number) maka type (equals/notEqual/greaterThan/greaterThanOrEqual/lessThan/lessThanOrEqual/inRange)
jika filterType (date) maka type (equals/notEqual/greaterThan/greaterThanOrEqual/lessThan/lessThanOrEqual/inRange)
jika filterType (set) maka type (array)
```

filter = value yang di filter:

```
jika filterType=number dan type=inRange harap gunakan filter & filterTo
jika filterType=date dan type=inRange harap gunakan dateFrom & dateTo
jika filterType=set dan type=array harap gunakan values dan isi value dalam format array []
```

Berikut adalah contoh detail penggunaan Filter Query

```json
#Contoh FilterType "text" dan type "equals":
{
  "status":{
    "filterType":"text",
    "type":"equals",
    "filter":"SELESAI"
  }
} 

#Contoh FilterType "number" dan type "greaterThanOrEqual":
{
  "umur":{
    "filterType":"number",
    "type":"greaterThanOrEqual",
    "filter":1
  }
} 

#Contoh FilterType "number" dan type "inRange":
{
  "umur":{
    "filterType":"number",
    "type":"inRange",
    "filter":1,
    "filterTo":10
  }
} 

#Contoh FilterType "date" dan type "greaterThanOrEqual":
{
  "_meta.createdAt":{
    "filterType":"date",
    "type":"greaterThan",
    "dateFrom":"2022-02-27"
  }
} 

#Contoh FilterType "date" dan type "inRange":
{
  "_meta.createdAt":{
    "filterType":"date",
    "type":"inRange",
    "dateFrom":"2022-02-27",
    "dateTo":"2022-03-04"
  }
} 

#Contoh FilterType "set" dan type "array":
{
  "status":{
    "filterType":"set",
    "type":"array",
    "values":["SELESAI","DIPROSES"]
  }
} 

#Contoh Multiple Filter Fields:
{
  "status":{
    "filterType":"set",
    "type":"array",
    "values":["SELESAI","DIPROSES"]
  },
  "_meta.createdAt":{
    "filterType":"date",
    "type":"inRange",
    "dateFrom":"2022-02-27",
    "dateTo":"2022-03-04"
  },
  "umur":{
    "filterType":"number",
    "type":"inRange",
    "filter":1,
    "filterTo":10
  }
} 
```

Anda dapat melakukan pengujian API dengan cara mengunduh postman collection yang disediakan seperti pada gambar berikut ini: ![](https://github.com/QTN-DEV/quantumbyte-doc/blob/main/img/v1/integrasi/doc4.png)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.quantumbyte.ai/home/quantumbyte-v2.0/2.builder/3.integrasi/api-formulir/4.read.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.