List Sender ID

To list all created Sender ID

List Sender ID

get

List all the senders

Authorizations

Query parameters

pageintegerOptional

Page number

Example: 1

filter[name]stringOptional

Filter by sender name

Example: DUCKSMS

filter[status]string · enumOptional

Filter by sender status

Example: activePossible values:

Responses

200

List all the senders

application/json

400

Invalid request

application/json

401

Unauthenticated

application/json

404

No data found

application/json

500

Server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/senders HTTP/1.1
Host: ducksms.com
Authorization: Bearer JWT
Accept: */*

{
  "status": 200,
  "message": "Senders data return successfully",
  "data": [
    {
      "id": 1,
      "name": "DUCKSMS",
      "description": "Example sender id description",
      "default": true,
      "status": "active",
      "created_at": "2022-11-29T03:28:39.000000Z",
      "updated_at": "2022-11-29T03:28:39.000000Z"
    },
    {
      "id": 2,
      "name": "MYCOMPANY",
      "description": "Example sender id description",
      "default": false,
      "status": "inactive",
      "created_at": "2022-11-30T03:28:39.000000Z",
      "updated_at": "2022-11-30T03:28:39.000000Z"
    }
  ]
}