> For the complete documentation index, see [llms.txt](https://kb.logicerp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/masters/pull/get-party-master.md).

# Get Party Master

Returns your **customers and suppliers** (parties) from Logic ERP: name, codes, addresses, contact details, GST details, account groups, agent and, if your setup allows it, the **current ledger balance**. Use it to keep the party list in your system in step with Logic ERP — normally by asking only for parties **added or changed** since your last call, or to look up a single party by its code.

### **Endpoint**

| Name          | Detail                                   |
| ------------- | ---------------------------------------- |
| Address       | `https://your-server/api/GetPartyMaster` |
| Method        | `POST`                                   |
| Authorization | Basic Auth                               |

The response and the common request fields are explained in [How Every API Call Works](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/how-every-api-call-works.md).

### **Request fields**

| Field                | Type   | Required | Default | Meaning                                                                                                                                                                                                                 |
| -------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GlobalModifyCode`   | number | No       | `0`     | Your bookmark in the change log, as described in How Every API Call Works. `0` = from the start (or a period, with `DateFrom`/`DateTo`), a number = only changes after it, `-1` = Logic ERP keeps the bookmark for you. |
| `DateFrom`, `DateTo` | date   | No       | empty   | A period of changes, used when `GlobalModifyCode` is `0`. Leave them out, or send both as `null`, when you are not asking for a period. Write them as `yyyy-MM-dd`.                                                     |
| `Doc_Codes`          | text   | No       | empty   | Logic ERP's internal party numbers (`ActCode` in the response), separated by commas, for example `"34,90"`. Returns exactly these parties; the bookmark and period are ignored. Numbers and commas only.                |
| `PartyUserCode`      | text   | No       | empty   | One party code as shown in Logic ERP (`User_Code` in the response), for example `"C1045"`. Returns that party whether or not it changed recently; the bookmark and period are ignored.                                  |

`Branch_Codes_From` and `Doc_Num_Like` are not useful here. Parties do not belong to a branch in the change log, so a period request with `Branch_Codes_From` filled returns nothing. `Doc_Num_Like` is matched against Logic ERP's internal party number (`ActCode`), not the party code. Leave both empty.

### **Rules Logic ERP applies**

* Only **customers and suppliers** are returned. Other accounts (bank, cash, expense and so on) are never returned, even when they appear in the change log.
* Your Logic ERP team can limit this endpoint to **certain account groups** in the API site setup. Parties outside those groups are never returned, whatever you send.
* **Batches.** With a bookmark, each call reads up to **200 change-log lines**. A party edited several times in that range is returned once. Because the change log also contains other accounts, a batch can hold fewer parties than lines, or none at all — in that case you get `"Party Not Found..."` with `Status: true` and a **higher** `LastGlobalModifyCode`. Store it and call again. You have caught up when the message is `"Party Master not found against Request..."`, `GetData` is `null` and `LastGlobalModifyCode` is the value you sent.
* **A party can come back in a later batch.** Every save of a party adds a new line to the change log, so a party changed again after your bookmark is returned again in a later batch, with its current details. Update the party in your system; do not insert it a second time.
* A period request (`GlobalModifyCode` `0` with `DateFrom` and `DateTo`) returns every party changed in the period in one call, with no 150-line limit, and `LastGlobalModifyCode` `0`.
* With `PartyUserCode` or `Doc_Codes`, `LastGlobalModifyCode` comes back as `0`. Do not store it as your bookmark.
* `PartyUserCode` must match the party code exactly. Spaces before or after the code are ignored.
* Parties are returned in order of `ActCode`.
* Parties that have been **deleted** in Logic ERP are not returned, so a deletion does not reach you through this endpoint. A party that is still present but flagged as deleted comes back with `Deleted_: true`.
* `LedgerBalance` is filled only when your Logic ERP team has switched on "ledger balance" for your API site; otherwise it is `0`. It is the party's balance in the **current financial year**, including the opening balance, across **all branches**. A positive amount means the party owes you (debit); a negative amount means you owe the party (credit).
* Dates in the response (`Create_Date`, `Modify_Date`) are text written day/month/four-digit year, for example `31/01/2026`.
* A link that is not set is shown as `(NIL)` (city, state, country, stock-transfer branch, general account group, the party's branch) or `NIL` (agent). Unused account group levels (`Group_Name1`…`Group_Name8`) are empty.

### **Example request**

Next batch after your stored bookmark:

```json
{
  "GlobalModifyCode": 8812,
  "DateFrom": null,
  "DateTo": null,
  "Doc_Codes": ""
}
```

One party by its code:

```json
{
  "GlobalModifyCode": 0,
  "DateFrom": null,
  "DateTo": null,
  "PartyUserCode": "C1045"
}
```

### **Test it**

Send a request to the Logic ERP **sandbox** (a test company) from this page: open the block below, enter the sandbox user name and password (ask your Logic ERP support team), change the request if you like, and press **Test it**. The example asks for the first batch of the change log. Do not send `"GlobalModifyCode": -1` here – it changes what the sandbox has marked as already sent.

## Get Party Master

> Returns your customers and suppliers (parties) from Logic ERP: name, codes, addresses, contact details, GST details, account groups, agent and, if your setup allows it, the current ledger balance. Use it to keep the party list in your system in step with Logic ERP — normally by asking only for parties added or changed since your last call, or to look up a single party by its code.

```json
{"openapi":"3.0.3","info":{"title":"Logic ERP API","version":"1.0"},"tags":[{"name":"Masters - Pull"}],"servers":[{"url":"https://demo.logicerp.com/api","description":"Logic ERP sandbox (test company)"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"The user name and password of your API site."}}},"paths":{"/GetPartyMaster":{"post":{"tags":["Masters - Pull"],"operationId":"GetPartyMaster","summary":"Get Party Master","description":"Returns your customers and suppliers (parties) from Logic ERP: name, codes, addresses, contact details, GST details, account groups, agent and, if your setup allows it, the current ledger balance. Use it to keep the party list in your system in step with Logic ERP — normally by asking only for parties added or changed since your last call, or to look up a single party by its code.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"GlobalModifyCode":{"type":"integer","description":"Your bookmark in the change log, as described in How Every API Call Works. `0` = from the start (or a period, with `DateFrom`/`DateTo`), a number = only changes after it, `-1` = Logic ERP keeps the bookmark for you."},"DateFrom":{"type":"string","nullable":true,"description":"A period of changes, used when `GlobalModifyCode` is `0`. Leave them out, or send both as `null`, when you are not asking for a period. Write them as `yyyy-MM-dd`."},"DateTo":{"type":"string","nullable":true,"description":"A period of changes, used when `GlobalModifyCode` is `0`. Leave them out, or send both as `null`, when you are not asking for a period. Write them as `yyyy-MM-dd`."},"Doc_Codes":{"type":"string","description":"Logic ERP's internal party numbers (`ActCode` in the response), separated by commas, for example `\"34,90\"`. Returns exactly these parties; the bookmark and period are ignored. Numbers and commas only."},"PartyUserCode":{"type":"string","description":"One party code as shown in Logic ERP (`User_Code` in the response), for example `\"C1045\"`. Returns that party whether or not it changed recently; the bookmark and period are ignored."}}}}}},"responses":{"200":{"description":"Always HTTP 200. Check Status, Message and GetData.","content":{"application/json":{"schema":{"type":"object","properties":{"GetData":{"type":"array","items":{"type":"object","properties":{"Act_Name":{"type":"string","description":"Party name."},"Act_Type":{"type":"string","description":"`CU` = customer, `SU` = supplier."},"Grp_Name":{"type":"string","description":"The party's general account group, or `(NIL)`."},"User_Code":{"type":"string","description":"The party code shown in Logic ERP. Use it as `PartyUserCode` to fetch this party again."},"ActCode":{"type":"integer","description":"Logic ERP's internal party number. Use it in `Doc_Codes`."},"Stock_Transfer_Party":{"type":"boolean","description":"`true` when the party is marked as a stock-transfer party in Logic ERP."},"Stock_Transfer_BranchCode":{"type":"integer","description":"The branch linked to this party for stock transfers; `0` when none. It can be filled even when `Stock_Transfer_Party` is `false`."},"Stock_Transfer_BranchName":{"type":"string","description":"Name of that branch, or `(NIL)`."},"IsCUOrSUAlso":{"type":"boolean","description":"`true` when the party is also used as the other type (a customer that is also a supplier, or the reverse)."},"AddlActUserCode":{"type":"string","description":"An additional party code, if one is kept in Logic ERP."},"Party_Add_1":{"type":"string","description":"First (main) address lines."},"Party_Add_2":{"type":"string","description":"First (main) address lines."},"Party_Add_3":{"type":"string","description":"First (main) address lines."},"PinCode":{"type":"string","description":"PIN code of the first address."},"City_Name":{"type":"string","description":"City, state and country of the first address, or `(NIL)`."},"State_Name":{"type":"string","description":"City, state and country of the first address, or `(NIL)`."},"Country_Name":{"type":"string","description":"City, state and country of the first address, or `(NIL)`."},"Party_Sec_Add_1":{"type":"string","description":"Second address lines (for example a delivery address)."},"Party_Sec_Add_2":{"type":"string","description":"Second address lines (for example a delivery address)."},"Party_Sec_Add_3":{"type":"string","description":"Second address lines (for example a delivery address)."},"Sec_PinCode":{"type":"string","description":"PIN code of the second address."},"Sec_City_Name":{"type":"string","description":"City, state and country of the second address, or `(NIL)`."},"Sec_State_Name":{"type":"string","description":"City, state and country of the second address, or `(NIL)`."},"Sec_Country_Name":{"type":"string","description":"City, state and country of the second address, or `(NIL)`."},"Telephone_off":{"type":"string","description":"Office and residence telephone numbers."},"Telephone_res":{"type":"string","description":"Office and residence telephone numbers."},"Fax_no":{"type":"string","description":"Fax number."},"Mobile_no":{"type":"string","description":"Mobile number."},"Email_address":{"type":"string","description":"E-mail address."},"Contact_Name":{"type":"string","description":"Contact person."},"GST_No":{"type":"string","description":"The party's GSTIN; empty or blank when unregistered."},"GST_State_Code":{"type":"string","description":"GST state code of the party."},"GST_Registration_Type":{"type":"string","description":"`Registered`, `UnRegistered` or `Composite`."},"Is_Ecommerce_Party":{"type":"boolean","description":"`true` when the party is an e-commerce operator."},"Ecommerce_GST_No":{"type":"string","description":"GSTIN of the e-commerce operator."},"Group_Name1":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name2":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name3":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name4":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name5":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name6":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name7":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Group_Name8":{"type":"string","description":"The party's account groups at levels 1 to 8; empty when a level is not used."},"Deleted_":{"type":"boolean","description":"`true` when the party is flagged as deleted."},"Create_Date":{"type":"string","description":"When the party was created, `dd/MM/yyyy`; empty if not known."},"Modify_Date":{"type":"string","description":"When the party was last changed, `dd/MM/yyyy`; empty if not known."},"Action_Code":{"type":"string","description":"The latest change made to the party: `N` = added, `M` = modified, `D` = deleted. Empty when Logic ERP has no record of a change (possible with `PartyUserCode` or `Doc_Codes`)."},"InActiveFor_SO":{"type":"boolean","description":"`true` when the party may not be used on new sale orders."},"Agent_Name":{"type":"string","description":"The party's agent or broker, or `NIL`."},"Agent_Short_Name":{"type":"string","description":"Short name of that agent, or `NIL`."},"Stop_Billing":{"type":"boolean","description":"`true` when billing to this party is blocked."},"BranchCode":{"type":"integer","description":"The branch the party is linked to; `0` when none."},"BranchName":{"type":"string","description":"Name of that branch, or `(NIL)`."},"BranchShortName":{"type":"string","description":"Short name of that branch, or `(NIL)`."},"Food_Lisc_No":{"type":"string","description":"Food licence (FSSAI) number."},"LedgerBalance":{"type":"number","description":"Current balance in ₹ — see the rules above. `0` when the ledger balance is not switched on."},"ListCustomFields":{"type":"array","items":{"type":"object","properties":{"FieldName":{"type":"string","description":"Name of the extra field."},"FieldValue_1":{"type":"string","nullable":true,"description":"The value for this party; `null` when none is entered."},"FieldValue_2":{"type":"string","nullable":true,"description":"A second value, used by some field types; `null` when the party has no value for this field, empty when only `FieldValue_1` is filled."},"FieldCode":{"type":"integer","description":"Internal number – ignore."}}},"description":"Extra fields your company has defined for parties. See below."}}},"nullable":true,"description":"The records found; null when the call failed or nothing was found - read Message."},"Status":{"type":"boolean","description":"See the Status rules on this page and on How Every API Call Works."},"Message":{"type":"string","description":"Why the call failed, or a note. The reason may be followed by technical detail - read the first line."},"LastGlobalModifyCode":{"type":"integer","description":"The change-log bookmark (see How Every API Call Works)."},"resultSize":{"type":"string","description":"Size of the answer, for example \"2 KB\"."}}}}}},"401":{"description":"No login was sent."}}}}}}
```

### **Response fields**

Each item in `GetData`:

| Field                                                   | Type         | Meaning                                                                                                                                                                             |
| ------------------------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Act_Name`                                              | text         | Party name.                                                                                                                                                                         |
| `Act_Type`                                              | text         | `CU` = customer, `SU` = supplier.                                                                                                                                                   |
| `Grp_Name`                                              | text         | The party's general account group, or `(NIL)`.                                                                                                                                      |
| `User_Code`                                             | text         | The party code shown in Logic ERP. Use it as `PartyUserCode` to fetch this party again.                                                                                             |
| `ActCode`                                               | number       | Logic ERP's internal party number. Use it in `Doc_Codes`.                                                                                                                           |
| `Stock_Transfer_Party`                                  | true / false | `true` when the party is marked as a stock-transfer party in Logic ERP.                                                                                                             |
| `Stock_Transfer_BranchCode`                             | number       | The branch linked to this party for stock transfers; `0` when none. It can be filled even when `Stock_Transfer_Party` is `false`.                                                   |
| `Stock_Transfer_BranchName`                             | text         | Name of that branch, or `(NIL)`.                                                                                                                                                    |
| `IsCUOrSUAlso`                                          | true / false | `true` when the party is also used as the other type (a customer that is also a supplier, or the reverse).                                                                          |
| `AddlActUserCode`                                       | text         | An additional party code, if one is kept in Logic ERP.                                                                                                                              |
| `Party_Add_1`, `Party_Add_2`, `Party_Add_3`             | text         | First (main) address lines.                                                                                                                                                         |
| `PinCode`                                               | text         | PIN code of the first address.                                                                                                                                                      |
| `City_Name`, `State_Name`, `Country_Name`               | text         | City, state and country of the first address, or `(NIL)`.                                                                                                                           |
| `Party_Sec_Add_1`, `Party_Sec_Add_2`, `Party_Sec_Add_3` | text         | Second address lines (for example a delivery address).                                                                                                                              |
| `Sec_PinCode`                                           | text         | PIN code of the second address.                                                                                                                                                     |
| `Sec_City_Name`, `Sec_State_Name`, `Sec_Country_Name`   | text         | City, state and country of the second address, or `(NIL)`.                                                                                                                          |
| `Telephone_off`, `Telephone_res`                        | text         | Office and residence telephone numbers.                                                                                                                                             |
| `Fax_no`                                                | text         | Fax number.                                                                                                                                                                         |
| `Mobile_no`                                             | text         | Mobile number.                                                                                                                                                                      |
| `Email_address`                                         | text         | E-mail address.                                                                                                                                                                     |
| `Contact_Name`                                          | text         | Contact person.                                                                                                                                                                     |
| `GST_No`                                                | text         | The party's GSTIN; empty or blank when unregistered.                                                                                                                                |
| `GST_State_Code`                                        | text         | GST state code of the party.                                                                                                                                                        |
| `GST_Registration_Type`                                 | text         | `Registered`, `UnRegistered` or `Composite`.                                                                                                                                        |
| `Is_Ecommerce_Party`                                    | true / false | `true` when the party is an e-commerce operator.                                                                                                                                    |
| `Ecommerce_GST_No`                                      | text         | GSTIN of the e-commerce operator.                                                                                                                                                   |
| `Group_Name1` … `Group_Name8`                           | text         | The party's account groups at levels 1 to 8; empty when a level is not used.                                                                                                        |
| `Deleted_`                                              | true / false | `true` when the party is flagged as deleted.                                                                                                                                        |
| `Create_Date`                                           | date         | When the party was created, `dd/MM/yyyy`; empty if not known.                                                                                                                       |
| `Modify_Date`                                           | date         | When the party was last changed, `dd/MM/yyyy`; empty if not known.                                                                                                                  |
| `Action_Code`                                           | text         | The **latest** change made to the party: `N` = added, `M` = modified, `D` = deleted. Empty when Logic ERP has no record of a change (possible with `PartyUserCode` or `Doc_Codes`). |
| `InActiveFor_SO`                                        | true / false | `true` when the party may not be used on new sale orders.                                                                                                                           |
| `Agent_Name`                                            | text         | The party's agent or broker, or `NIL`.                                                                                                                                              |
| `Agent_Short_Name`                                      | text         | Short name of that agent, or `NIL`.                                                                                                                                                 |
| `Stop_Billing`                                          | true / false | `true` when billing to this party is blocked.                                                                                                                                       |
| `BranchCode`                                            | number       | The branch the party is linked to; `0` when none.                                                                                                                                   |
| `BranchName`                                            | text         | Name of that branch, or `(NIL)`.                                                                                                                                                    |
| `BranchShortName`                                       | text         | Short name of that branch, or `(NIL)`.                                                                                                                                              |
| `Food_Lisc_No`                                          | text         | Food licence (FSSAI) number.                                                                                                                                                        |
| `LedgerBalance`                                         | number       | Current balance in ₹ — see the rules above. `0` when the ledger balance is not switched on.                                                                                         |
| `ListCustomFields`                                      | list         | Extra fields your company has defined for parties. See below.                                                                                                                       |

When a party's address details are missing in Logic ERP, the address, contact, GST, city/state/country (both addresses) and `Food_Lisc_No` fields come back as `null`, and `Is_Ecommerce_Party` and `InActiveFor_SO` as `false`.

**`ListCustomFields`** — one entry for each visible extra field defined for parties, in the order set in Logic ERP, whether or not this party has a value:

| Field          | Type   | Meaning                                                                                                                                |
| -------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `FieldName`    | text   | Name of the extra field.                                                                                                               |
| `FieldValue_1` | text   | The value for this party; `null` when none is entered.                                                                                 |
| `FieldValue_2` | text   | A second value, used by some field types; `null` when the party has no value for this field, empty when only `FieldValue_1` is filled. |
| `FieldCode`    | number | Internal number – ignore.                                                                                                              |

### **Example response**

```json
{
  "GetData": [
    {
      "Act_Name": "SHREE GANESH TEXTILES",
      "Act_Type": "CU",
      "Grp_Name": "SUNDRY DEBTORS",
      "User_Code": "C1045",
      "ActCode": 1045,
      "Stock_Transfer_Party": false,
      "Stock_Transfer_BranchCode": 0,
      "Stock_Transfer_BranchName": "(NIL)",
      "IsCUOrSUAlso": false,
      "AddlActUserCode": "",
      "Party_Add_1": "14, Gandhi Market",
      "Party_Add_2": "Near Clock Tower",
      "Party_Add_3": "",
      "PinCode": "141008",
      "City_Name": "LUDHIANA",
      "State_Name": "PUNJAB",
      "Country_Name": "INDIA",
      "Party_Sec_Add_1": "",
      "Party_Sec_Add_2": "",
      "Party_Sec_Add_3": "",
      "Sec_PinCode": "",
      "Sec_City_Name": "(NIL)",
      "Sec_State_Name": "(NIL)",
      "Sec_Country_Name": "(NIL)",
      "Telephone_off": "0161-2401234",
      "Telephone_res": "",
      "Fax_no": "",
      "Mobile_no": "9814012345",
      "Email_address": "accounts@shreeganesh.in",
      "Contact_Name": "Rakesh Bansal",
      "GST_No": "03ABCPB1234F1Z5",
      "GST_State_Code": "03",
      "GST_Registration_Type": "Registered",
      "Is_Ecommerce_Party": false,
      "Ecommerce_GST_No": "",
      "Group_Name1": "NORTH ZONE",
      "Group_Name2": "WHOLESALE",
      "Group_Name3": "",
      "Group_Name4": "",
      "Group_Name5": "",
      "Group_Name6": "",
      "Group_Name7": "",
      "Group_Name8": "",
      "Deleted_": false,
      "Create_Date": "12/04/2024",
      "Modify_Date": "03/10/2026",
      "Action_Code": "M",
      "InActiveFor_SO": false,
      "Agent_Name": "MAHESH KUMAR",
      "Agent_Short_Name": "MK",
      "Stop_Billing": false,
      "BranchCode": 2,
      "BranchName": "LUDHIANA MAIN",
      "BranchShortName": "LDH",
      "Food_Lisc_No": "",
      "LedgerBalance": 48250.00,
      "ListCustomFields": [
        { "FieldName": "Credit Days", "FieldValue_1": "30", "FieldValue_2": "", "FieldCode": 51 }
      ]
    }
  ],
  "Status": true,
  "Message": "",
  "LastGlobalModifyCode": 8901,
  "resultSize": "3 KB"
}
```

### **Messages you may see**

| Message                                                                                                              | Meaning                                                                                                                                                                                                                  | What to do                                                                                                                                                           |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Party Master not found against Request...* (with `Status: true`)                                                    | Nothing has been added to the change log after your bookmark.                                                                                                                                                            | You are up to date. Call again later with the same bookmark.                                                                                                         |
| *Party Not Found...* (with `Status: true`)                                                                           | No customer or supplier you can see was found: only other accounts changed in this batch, the parties are outside your account groups, nothing changed in the period you asked for, or the code you sent does not exist. | With a bookmark: store the new `LastGlobalModifyCode` and call again. With a period: there is nothing to fetch. With `PartyUserCode` or `Doc_Codes`: check the code. |
| `Invalid code in list: '…'. Only numeric codes are allowed.` (with `Status: false`), where `…` is the value you sent | `Doc_Codes` contained something other than numbers and commas.                                                                                                                                                           | Send `Doc_Codes` as numbers separated by commas.                                                                                                                     |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/masters/pull/get-party-master.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
