Home › Patterns

Get List of User's Patterns — FarazSMS SMS web service

GET https://api.iranpayamak.com/ws/v1/patterns

Purpose: List your account's patterns; find a pattern's `code` here to send with it.

Authentication

This endpoint requires the Api-Key header — get the key from the FarazSMS panel. The header name is case-sensitive and the key must never travel in a query string.

Request fields

• text (string) — required
• description (string) — optional
• shared (boolean) — required
• website (string) — required
• attributes (array) — optional

Notes for this endpoint

• Returns your account's patterns.
• Find the pattern code you need for sending here.

Example body

{
  "search": "",
  "staus": "active",
  "share": 1,
  "sort_by": "updated_at",
  "sort_type": "desc"
}

Responses

• 201 — Pattern created successfully.

Related endpoints in Patterns

• PUT /ws/v1/patterns/{code} — Edit Pattern
• GET /ws/v1/patterns/{code} — Get Pattern Details
• DELETE /ws/v1/patterns/{code} — Delete Pattern

All FarazSMS web services · llms.txt · OpenAPI