Get List of User's Patterns

GET

https://api.iranpayamak.com/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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.iranpayamak.com/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

Edit Pattern

index