> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thiqwave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Partner

> Retrieve your own partner profile or list all sub-partners.

## GET /v1/partners/me

```
GET https://api.thiqwave.com/v1/partners/me
```

### Description

Retrieve your own partner profile. Use this endpoint to inspect your account details, check your current status.

### Request

#### Headers

<ParamField header="X-API-Key" type="string" required>
  Your Thiqwave API key.
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.thiqwave.com/v1/partners/me \
    -H "X-API-Key: your-api-key"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.thiqwave.com/v1/partners/me', {
    headers: {
      'X-API-Key': 'your-api-key',
    },
  });

  const profile = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.thiqwave.com/v1/partners/me',
      headers={'X-API-Key': 'your-api-key'},
  )

  profile = response.json()
  ```
</CodeGroup>

### Response

<ResponseField name="id" type="string">
  Your partner ID.
</ResponseField>

<ResponseField name="name" type="string">
  Your registered business name.
</ResponseField>

<ResponseField name="email" type="string">
  Your primary contact email address.
</ResponseField>

<ResponseField name="status" type="string">
  Your account status. Possible values: `"pending"`, `"active"`, `"suspended"`.
</ResponseField>

<ResponseField name="createdAt" type="string">
  The ISO 8601 timestamp of when your account was created.
</ResponseField>

#### Example response

```json theme={null}
{
  "id": "prtnr_01HZ2KJ8VBNC4W3M9RFQTX6YP",
  "name": "Acme Financial Services",
  "email": "admin@acmefinancial.ae",
  "status": "active",
  "createdAt": "2025-11-14T08:00:00Z"
}
```

***

## GET /v1/partners

```
GET https://api.thiqwave.com/v1/partners
```

### Description

List all sub-partners under your account. This endpoint is restricted to admin-level partners and returns a paginated array of sub-partner objects.

### Request

#### Headers

<ParamField header="X-API-Key" type="string" required>
  Your Thiqwave API key.
</ParamField>

#### Query parameters

<ParamField query="page" type="integer">
  The page number to retrieve. Defaults to `1`.
</ParamField>

<ParamField query="limit" type="integer">
  The number of results per page. Defaults to `20`. Maximum value is `100`.
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://api.thiqwave.com/v1/partners?page=1&limit=20" \
    -H "X-API-Key: your-api-key"
  ```

  ```javascript JavaScript theme={null}
  const params = new URLSearchParams({ page: '1', limit: '20' });

  const response = await fetch(`https://api.thiqwave.com/v1/partners?${params}`, {
    headers: {
      'X-API-Key': 'your-api-key',
    },
  });

  const { data, meta } = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.thiqwave.com/v1/partners',
      headers={'X-API-Key': 'your-api-key'},
      params={'page': 1, 'limit': 20},
  )

  result = response.json()
  ```
</CodeGroup>

### Response

The response is a paginated object containing an array of partner records and pagination metadata.

<ResponseField name="data" type="array">
  Array of partner objects.

  <Expandable title="Partner object fields">
    <ResponseField name="id" type="string">
      The partner's unique identifier.
    </ResponseField>

    <ResponseField name="name" type="string">
      The business name.
    </ResponseField>

    <ResponseField name="email" type="string">
      The primary contact email.
    </ResponseField>

    <ResponseField name="status" type="string">
      Account status: `"pending"`, `"active"`, or `"suspended"`.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO 8601 creation timestamp.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="meta" type="object">
  Pagination metadata.

  <Expandable title="Meta fields">
    <ResponseField name="total" type="integer">
      Total number of sub-partners across all pages.
    </ResponseField>

    <ResponseField name="page" type="integer">
      The current page number.
    </ResponseField>

    <ResponseField name="limit" type="integer">
      The number of results returned per page.
    </ResponseField>
  </Expandable>
</ResponseField>

#### Example response

```json theme={null}
{
  "data": [
    {
      "id": "prtnr_01HZ2KJ8VBNC4W3M9RFQTX6YP",
      "name": "Noon Payments LLC",
      "email": "api@noonpayments.ae",
      "status": "active",
      "createdAt": "2026-01-20T14:15:00Z"
    },
    {
      "id": "prtnr_01HZ3LK9WCOD5X4N0SGRUVY7ZQ",
      "name": "STC Pay Partners",
      "email": "platform@stcpay.com.sa",
      "status": "pending",
      "createdAt": "2026-03-05T09:45:00Z"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "limit": 20
  }
}
```

<Note>
  This endpoint requires admin-level access. If your account does not have the required permissions, the API returns a `403 Forbidden` response.
</Note>