---
title: "Fetch SIP details"
method: GET
path: "/{gatewayname}/engine/user/sip"
---

# Fetch SIP details

`GET /{gatewayname}/engine/user/sip`

## Request

- Base URL: `https://gatewayapi.smallcase.com/v1`
- URL: `https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/user/sip`
- Auth: none required

The API provides the SIP details for a given iscid. The API provides details like smallcase id (scid), sip active status, frequency, sip amount, sip type, scheduledDate for the next sip etc.

**<<apiUseCaseTerm>>**:  This API is ideal when you want to display SIP related details to the user for an iscid.

## Path parameters

- `gatewayname` string, required

## Query parameters

- `iscid` string, required

## Headers

- `x-gateway-secret` string, required
- `x-gateway-authtoken` string, required

## Response `200`

200

- union
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object
      - `iscid` string
      - `scid` string
      - `sipActive` boolean
      - `scheduledDate` string
      - `frequency` string
      - `amount` number
      - `sipType` string
      - `smallcaseAuthToken` string
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object
      - `iscid` string
      - `scid` string
      - `sipActive` boolean
      - `smallcaseAuthToken` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/smallcase/apis/smallcase-data-v1.md) - [All operations](https://skmtc.dev/smallcase/apis/smallcase-data-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/smallcase/apis/smallcase-data-v1/revisions/9e1b64a1d830?raw)