تیم‌ها

دریافت همه

GET https://linkcomposer.com/api/teams/
curl --request GET \
--url 'https://linkcomposer.com/api/teams/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها جزئیات توضیحات
search اختیاری رشته (String) عبارت جستجو.
search_by اختیاری رشته (String) فیلدی که بر اساس آن جستجو می‌کنید. مقادیر مجاز: name.
datetime_field اختیاری رشته (String) مقادیر مجاز: datetime, last_datetime
datetime_start اختیاری رشته (String) فیلتر نتایج از این تاریخ و زمان به بعد. با قالب Y-m-d H:i:s.
datetime_end اختیاری رشته (String) فیلتر نتایج تا این تاریخ و زمان. با قالب Y-m-d H:i:s.
order_by اختیاری رشته (String) فیلدی که نتایج بر اساس آن مرتب می‌شوند. مقادیر مجاز: team_id, datetime, last_datetime, name.
order_type اختیاری رشته (String) ترتیب نتایج. مقادیر مجاز: ASC برای ترتیب صعودی و DESC برای ترتیب نزولی.
page اختیاری عدد صحیح (Integer) شماره صفحه‌ای که می‌خواهید نتایج آن را دریافت کنید. مقدار پیش‌فرض 1 است.
results_per_page اختیاری عدد صحیح (Integer) تعداد نتایج در هر صفحه. مقادیر مجاز: 10, 25, 50, 100, 250, 500, 1000. مقدار پیش‌فرض 25 است. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example team",
            "team_members": [
                {
                    "team_member_id": 1,
                    "user_email": "hello@example.com",
                    "access": {
                        "read": true,
                        "create": true,
                        "update": true,
                        "delete": false
                    },
                    "status": 1,
                    "datetime": "2026-10-03 00:01:55",
                    "last_datetime": null
                }
            ],
            "last_datetime": null,
            "datetime": "2026-10-03 00:01:55"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://linkcomposer.com/api/teams?page=1",
        "last": "https://linkcomposer.com/api/teams?page=1",
        "next": null,
        "prev": null,
        "self": "https://linkcomposer.com/api/teams?page=1"
    }
}

دریافت یک مورد

GET https://linkcomposer.com/api/teams/{team_id}
curl --request GET \
--url 'https://linkcomposer.com/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example team",
        "team_members": [
            {
                "team_member_id": 1,
                "user_email": "hello@example.com",
                "access": {
                    "read": true,
                    "create": true,
                    "update": true,
                    "delete": false
                },
                "status": 1,
                "datetime": "2026-10-03 00:01:55",
                "last_datetime": null
            }
        ],
        "last_datetime": null,
        "datetime": "2026-10-03 00:01:55"
    }
}

ایجاد

POST https://linkcomposer.com/api/teams
پارامترها جزئیات توضیحات
name الزامی رشته (String) -
curl --request POST \
--url 'https://linkcomposer.com/api/teams' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My team' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "My team",
        "team_members": [],
        "last_datetime": null,
        "datetime": "2026-10-03 00:01:55"
    }
}

به‌روزرسانی

POST https://linkcomposer.com/api/teams/{team_id}
پارامترها جزئیات توضیحات
name اختیاری رشته (String) -
curl --request POST \
--url 'https://linkcomposer.com/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My new team name' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "My new team name",
        "team_members": [
            {
                "team_member_id": 1,
                "user_email": "hello@example.com",
                "access": {
                    "read": true,
                    "create": true,
                    "update": true,
                    "delete": false
                },
                "status": 1,
                "datetime": "2026-10-03 00:01:55",
                "last_datetime": null
            }
        ],
        "last_datetime": "2026-10-03 00:01:55",
        "datetime": "2026-10-03 00:01:55"
    }
}

حذف

DELETE https://linkcomposer.com/api/teams/{team_id}
curl --request DELETE \
--url 'https://linkcomposer.com/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \