---
title: "Retrieve Request Details using Type and Subtype"
method: GET
path: "/requests"
---

# Retrieve Request Details using Type and Subtype

`GET /requests`

Allows you to retrieve request details with desired filters.

## Query parameters

- `requestType` string, required
- `requestSubType` string, required
- `limit` integer
- `offset` string
- `sort` 'ADDED_ON' | 'LAST_UPDATED_ON'
- `order` string
- `status` 'PENDING' | 'REJECTED' | 'APPROVED' | 'SUCCESS' | 'FAILURE'
- `Customer identification` object, required
  - `source` string, required — Defines the source from which the transaction is made. Example: INSTORE, WECHAT, WEB_ENGAGE (Web-engage integration) etc.
  - `identifierType` string, required — Defines any of the registered identifier name of the customer. Values: mobile, email, externalId, id, WeChat, cardnumber, cardExternalId
  - `identifierValue` string, required — Defines the respective identifier value. For example, if identifierType is mobile, identifierValue is mobile number.
- `start_date` string, date
- `end_date` string, date

## Response `200`

200

- union
  - object
    - `pagination` object
      - `limit` integer
      - `offset` integer
      - `sortBy` string
      - `sortOrder` string
      - `total` integer
    - `data` object[]
      - `type` string
      - `baseType` string
      - `status` string
      - `transaction` object
        - `extendedFields` object
          - `checkin_date` string
          - `checkout_date` string
          - `ship_first_name` string
          - `ship_last_name` string
        - `deliveryStatus` string
        - `type` string
        - `billAmount` integer
        - `billNumber` string
        - `discount` integer
        - `grossAmount` integer
        - `note` string
        - `lineItemsV2` object[]
          - `amount` number
          - `itemCode` string
          - `qty` integer
          - `rate` number
          - `returnable` boolean
          - `returnableDays` integer
          - `comboDetails` unknown[]
            - unknown
          - `addOnDetails` unknown[]
            - unknown
          - `splitDetails` unknown[]
            - unknown
          - `extendedFields` object
            - `GrossWeight` string
            - `MetalRate` string
        - `customFields` object
          - `paymentmode` string
        - `notInterestedReason` string
        - `userGroup2Id` integer
        - `userGroup2ExternalId` string
        - `userGroup2PrimaryUserId` integer
        - `isUseDefaultUserGroup2` boolean
        - `paymentModes` object[]
          - `mode` string
          - `value` integer
          - `notes` string
          - `attributes` object
            - `card_type` string
        - `billingDate` string
        - `useDefaultUserGroup2` boolean
      - `images` object[]
        - `id` integer
        - `provider` string
        - `namespace` string
        - `serial` integer
        - `fileName` string
        - `imageReference` string
        - `filePath` string
        - `securedFilePath` string
        - `active` boolean
      - `customer` object
        - `id` integer
        - `profiles` object[]
          - `firstName` string
          - `lastName` string
          - `fields` object
          - `identifiers` object[]
            - `type` string
            - `value` string
          - `commChannels` unknown[]
            - unknown
          - `userId` integer
          - `accountId` string
          - `autoUpdateTime` string
          - `identifiersAll` object[]
            - `type` string
            - `value` string
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `id` integer
          - `code` string
          - `description` string
          - `name` string
          - `type` string
          - `adminType` string
          - `isActive` boolean
          - `isOuEnabled` boolean
          - `timeZoneId` integer
          - `currencyId` integer
          - `languageId` integer
        - `modifiedBy` object
          - `id` integer
          - `code` string
          - `description` string
          - `name` string
          - `type` string
          - `adminType` string
          - `isActive` boolean
          - `isOuEnabled` boolean
          - `timeZoneId` integer
          - `currencyId` integer
          - `languageId` integer
        - `modifiedDate` string
      - `id` integer
      - `addedOn` string
      - `userId` integer
      - `comments` string
      - `oneStep` boolean
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
  - object
    - `pagination` object
      - `limit` integer
      - `offset` integer
      - `sortBy` string
      - `sortOrder` string
      - `total` integer
    - `data` object[]
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `referenceId` integer
          - `default` boolean
        - `modifiedBy` object
          - `referenceId` integer
          - `default` boolean
        - `modifiedDate` string
      - `userId` integer
      - `changeIdentifierRequest` object
        - `id` integer
        - `userId` integer
        - `requestId` integer
        - `changeIdentifiers` object
          - `add` object[]
            - `type` string
            - `value` string
          - `remove` object[]
            - `type` string
            - `value` string
        - `oneStep` boolean
      - `oneStep` boolean
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
  - object
    - `pagination` object
      - `limit` integer
      - `offset` integer
      - `sortBy` string
      - `sortOrder` string
      - `total` integer
    - `data` object[]
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `referenceId` integer
          - `default` boolean
        - `modifiedBy` object
          - `referenceId` integer
          - `default` boolean
        - `modifiedDate` string
      - `userId` integer
      - `changeIdentifierRequest` object
        - `id` integer
        - `userId` integer
        - `requestId` integer
        - `changeIdentifiers` object
          - `add` object[]
            - `type` string
            - `value` string
          - `remove` object[]
            - `type` string
            - `value` string
        - `oneStep` boolean
      - `oneStep` boolean
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
  - object
    - `pagination` object
      - `limit` integer
      - `offset` integer
      - `sortBy` string
      - `sortOrder` string
      - `total` integer
    - `data` object[]
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `referenceId` integer
          - `default` boolean
        - `modifiedBy` object
          - `referenceId` integer
          - `default` boolean
        - `modifiedDate` string
      - `userId` integer
      - `changeIdentifierRequest` object
        - `id` integer
        - `userId` integer
        - `requestId` integer
        - `changeIdentifiers` object
          - `add` object[]
            - `type` string
            - `value` string
          - `remove` object[]
            - `type` string
            - `value` string
        - `oneStep` boolean
      - `oneStep` boolean
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)