post: tags: - Account summary: To get List of Accounts description: Returns list of accounts matching with given filters applied. operationId: list requestBody: $ref: "#components/requestBodies/request-body" responses: 200: $ref: "#components/responses/200" 422: $ref: "#components/responses/422" components: requestBodies: request-body: required: true, content: application/json: schema: type: object required: - select - limit - offset properties: select: type: object required: - fields properties: fields: type: array where: type: object limit: type: integer offset: type: integer order: type: object examples: basic: summary: Get only required columns with simple filters value: { "select": { "fields": [ "Id", "Sfid", "Name", "AccountManager", "CentralSalesRep", "BillingState", "ManagerType" ] }, "where": { "InActive": true, "TestAccount": false, }, "limit": 20, "offset": 0, } advanced: summary: Get all columns with more advanced filters value: { "select": { "fields": [ "*" ] }, "where": { "InActive": true, "TestAccount": false, "Name": { "operator": "like", "value": "sitka%" }, "CreatedDate": { "operator": ">=", "value": "2022-01-01" }, "sfid": { "operator": "in", "value": [ "sfid1", "sfid2", "sfid3" ] } }, "limit": 20, "offset": 0, "order": { "Name": "asc" } } responses: 200: description: Record found successfully or record not present in the system content: application/json: examples: record-found: summary: Record Found. value: { "data": [ { "Id": 1325, "Sfid": "001i0000016DI1yAAG", "Name": "1431 Property Management, LLC", "AccountManager": null, "CentralSalesRep": null, "BillingState": "TX", "ManagerType": "3rd Party - SF" }, { "Id": 1318, "Sfid": "001i0000016DGflAAG", "Name": "1836 Realty & Property Management", "AccountManager": null, "CentralSalesRep": null, "BillingState": "TX", "ManagerType": "3rd Party - SF" } ] } no-record-found: summary: No Record Found. value: { "data": "" } 422: description: Required data not provided. content: application/json: example: { "errors": { "select": "Please add parameter select in request body.", "select.fields": "Please provide * or column names for fields in request body.", "limit": "Please add parameter limit in request body.", "offset": "Please add parameter offset in request body." } }