---
title: "Get Module"
method: GET
path: "/modules/{moduleId}"
tags: ["Modules"]
---

# Get Module

`GET /modules/{moduleId}`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/modules/{moduleId}`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/modules/:moduleId/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a module object based on a module ID.
### Authorization Required:
  - Application View

## Path parameters

- `moduleId` string, required

## Response `200`

Module

- ModuleResponse
  - `id` string, required
  - `name` string, required
  - `title` string, required
  - `created` string, date-time, required
  - `modified` string, date-time, required

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)