Get Phonebooks

GET

https://api.iranpayamak.com/ws/v1/phone_book

Get paged list of phonebooks

Request

Authorization

Add parameter in header

Api-Key

Example:

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

Query Params

Header Params

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/phone_book?page&limit' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>'

Responses

🟢200Phonebooks retrieved successfully.

application/json

Body

Example

{
    "status": "success",
    "data": {
        "currentPage": 0,
        "totalPages": 0,
        "totalItems": 0,
        "itemsPerPage": 0,
        "items": [
            {
                "id": 0,
                "title": "string",
                "records": 0,
                "attributes": [
                    {
                        "id": 0,
                        "title": "string",
                        "type": "date",
                        "code": "string"
                    }
                ]
            }
        ]
    },
    "messages": "string"
}

Modified at 2025-11-03 11:24:11

Send Pattern-Based SMS

Create New Phonebook