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

# Get Sender IDs

> Retrieve a list of approved sender IDs

## Get Sender IDs

Retrieve a list of all approved sender IDs in your account.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://app.notify.ng/api/v2/SenderId?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
    -H "Content-Type: application/json"
  ```

  ```javascript JavaScript theme={null}
  const params = new URLSearchParams({
    ApiKey: 'YOUR_API_KEY',
    ClientId: 'YOUR_CLIENT_ID'
  });

  const response = await fetch(`https://app.notify.ng/api/v2/SenderId?${params}`, {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json'
    }
  });

  const data = await response.json();
  console.log(data);
  ```

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

  url = "https://app.notify.ng/api/v2/SenderId"
  params = {
      "ApiKey": "YOUR_API_KEY",
      "ClientId": "YOUR_CLIENT_ID"
  }

  response = requests.get(url, params=params)
  data = response.json()
  print(data)
  ```
</CodeGroup>

## Parameters

<ParamField query="ApiKey" type="string" required>
  Your API key for authentication
</ParamField>

<ParamField query="ClientId" type="string" required>
  Your client identifier for authentication
</ParamField>

## Response

<ResponseField name="ErrorCode" type="number">
  Error code (0 for success)
</ResponseField>

<ResponseField name="ErrorDescription" type="string">
  Description of the result
</ResponseField>

<ResponseField name="Data" type="array">
  Array of sender ID objects
</ResponseField>

<ResponseField name="Data[].Id" type="number">
  Unique identifier for the sender ID
</ResponseField>

<ResponseField name="Data[].CompanyId" type="number">
  Company identifier
</ResponseField>

<ResponseField name="Data[].Sender-Id" type="string">
  The sender ID text
</ResponseField>

<ResponseField name="Data[].Purpose" type="string">
  Purpose or description of the sender ID
</ResponseField>

<ResponseField name="Data[].IsActive" type="boolean">
  Whether the sender ID is currently active
</ResponseField>

<ResponseField name="Data[].CreatedDate" type="string">
  Date when the sender ID was created
</ResponseField>

<ResponseField name="Data[].ApproveStatus" type="string">
  Approval status of the sender ID
</ResponseField>

<ResponseField name="Data[].ApprovedDate" type="string">
  Date when the sender ID was approved
</ResponseField>

### Success Response

```json theme={null}
{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    {
      "Id": 94,
      "CompanyId": 47,
      "Sender-Id": "SMS123",
      "Purpose": "TEST",
      "IsActive": true,
      "CreatedDate": "Nov 20, 2018",
      "ApproveStatus": "Approved",
      "ApprovedDate": "Nov 21, 2018"
    }
  ]
}
```

## Sender ID Guidelines

* **Alphanumeric**: Use only letters and numbers
* **Length**: Typically 3-11 characters
* **Approval**: All sender IDs must be approved before use
* **Purpose**: Provide clear purpose for each sender ID
* **Compliance**: Follow local regulations and carrier requirements

## Use Cases

* **Brand recognition**: Use consistent sender IDs for brand awareness
* **Compliance**: Ensure all sender IDs are properly approved
* **Management**: Track and manage multiple sender IDs
* **Integration**: Sync sender ID data with your application