FarazSMS Public APIs
  1. Pattern
FarazSMS Public APIs
  • Account
    • Profile
      GET
    • Account Balance
      GET
    • update
      POST
    • Charge wallet
      POST
    • Register
      POST
  • Send
    • Send Sample SMS
      POST
    • Send Simple SMS
      POST
    • Send Simple SMS from Excel
      POST
    • Send SMS with Variables
      POST
    • Send SMS with Variables from Excel
      POST
    • Send Peer-to-Peer SMS
      POST
    • Send Peer-to-Peer SMS from Excel
      POST
    • Send Pattern-Based SMS
      POST
  • Phonebook
    • Get Phonebooks
      GET
    • Create New Phonebook
      POST
    • Get Phonebook Attributes
      GET
    • Create New Phonebook Attribute
      POST
    • Get Phonebook Contacts
      GET
  • Pattern
    • Create New Pattern
      POST
    • Get Pattern Details
      GET
    • Edit Pattern
      PUT
    • Get List of User's Patterns
      GET
  • Get Paged Inbox Messages
    GET
  1. Pattern

Get List of User's Patterns

GET
/ws/v1/patterns

Request

Authorization
Add parameter in header
Api-Key
Example:
Api-Key: ********************
Header Params

Body Params application/json

Example
{
    "search": "", // nullable|string
    "staus": "active", // nullable|in:pending,rejected,active
    "share": 1, // 'nullable|boolean'
    "sort_by":  "updated_at", // 'nullable|string|in:created_at,updated_at'
    "sort_type":  "desc", // 'nullable|string|in:asc,desc'
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/ws/v1/patterns' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "search": "", // nullable|string
    "staus": "active", // nullable|in:pending,rejected,active
    "share": 1, // '\''nullable|boolean'\''
    "sort_by":  "updated_at", // '\''nullable|string|in:created_at,updated_at'\''
    "sort_type":  "desc", // '\''nullable|string|in:asc,desc'\''
}'

Responses

🟢201Pattern created successfully.
application/json
Body

Example
{
    "status": "success",
    "data": "string",
    "messages": "string"
}
Modified at 2025-09-21 18:54:12
Previous
Edit Pattern
Next
Get Paged Inbox Messages
Built with