Get Pattern Details

GET

https://api.iranpayamak.com/ws/v1/patterns/{code}

This endpoint help to get a pattern by its "code"

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "text": "string",
    "description": "string",
    "shared": true,
    "website": "http://example.com",
    "attributes": [
        {
            "length": 0,
            "name": "string",
            "type": "string"
        }
    ]
}

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 '{
    "text": "string",
    "description": "string",
    "shared": true,
    "website": "http://example.com",
    "attributes": [
        {
            "length": 0,
            "name": "string",
            "type": "string"
        }
    ]
}'

Responses

🟢201Pattern created successfully.

application/json

Body

Example

{
    "status": "success",
    "data": "string",
    "messages": "string"
}

Modified at 2025-09-21 18:53:43

Create New Pattern

Edit Pattern