إرسال
Project

Get Project Details

Retrieve the details of the authenticated project

Endpoint

GET /api/project/details

Example

curl https://sms.lamah.com/api/project/details \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response

{
  "project_name": "RealEstate SMS",
  "description": "Property notifications and OTPs",
  "company": "Lamah Co",
  "status": "active",
  "type": "production",
  "subscription": [
    {
      "plan_name": "Business",
      "started_at": "2024-01-01T00:00:00Z",
      "expired_at": "2024-12-31T23:59:59Z",
      "canceled_at": null,
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}
FieldTypeDescription
project_namestringProject name
descriptionstringProject description
companystringCompany name
statusstringProject status
typestringProject type (e.g., production)
subscriptionarraySubscriptions that have not yet expired, each with its plan name. Empty when the project runs on wallet payment only

Subscription array items

FieldTypeDescription
plan_namestringPlan name for this subscription
started_atstringISO 8601 start date of subscription
expired_atstring|nullISO 8601 expiration date
canceled_atstring|nullISO 8601 cancellation date, or null if not canceled
created_atstringISO 8601 creation timestamp

Error responses

401 Unauthorized

{ "message": "Invalid or missing token." }
{ "message": "Project is inactive." }
{ "message": "Unauthorized IP address." }

This endpoint is also useful for verifying your API token — a 200 response confirms both that the token is valid and that your IP is whitelisted.

On this page