Skip to content
Scrappa Get API key
Zameen API 1 credit/request

Zameen Agency Agents API Documentation

GET https://scrappa.co/api/zameen/agency/agents

Zameen Agency Agents API Get the public agency page of an agency: owner, address, website, city, offices, the agents with name, designation, photo and mobile number as published, and the listing counts by purpose and type. E-mail addresses are never returned. The data comes from one call to the public agency page.

Zameen Agency Agents API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zameen/agency/agents
Auth header
x-api-key
Cost
1 credit/request
id = 1234567890
Response preview
200 OK
{
    "data": {
        "id": "190203",
        "city": "Karachi",
        "logo": "https://zameen-images-live.s3-eu-west-1.amazonaws.com/agency_logo/90a5a24c-9ad9-43fd-9452-e74048a3b589/thumbnail.jpg",
        "name": "Ali Estate",
        "owner": {
            "name": "Ali Abbas Noorani",
            "photo": "https://zameen-images-live.s3-eu-west-1.amazonaws.com/user_profile/5a373fff-b3ed-44ee-ba98-fbd887dffd02/thumbnail.jpg",
            "designation": "Supervisor"
        },
        "phone": null,
        "agents": [
            {
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

id string Required

Agency id, e.g. 190203. Returns the public agency page data: owner, offices, agents and listing counts.

Example value 1234567890

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "id": "190203",
        "city": "Karachi",
        "logo": "https://zameen-images-live.s3-eu-west-1.amazonaws.com/agency_logo/90a5a24c-9ad9-43fd-9452-e74048a3b589/thumbnail.jpg",
        "name": "Ali Estate",
        "owner": {
            "name": "Ali Abbas Noorani",
            "photo": "https://zameen-images-live.s3-eu-west-1.amazonaws.com/user_profile/5a373fff-b3ed-44ee-ba98-fbd887dffd02/thumbnail.jpg",
            "designation": "Supervisor"
        },
        "phone": null,
        "agents": [
            {
                "id": "1001142870",
                "name": "Ali Abbas Noorani",
                "photo": "https://zameen-images-live.s3-eu-west-1.amazonaws.com/user_profile/5a373fff-b3ed-44ee-ba98-fbd887dffd02/thumbnail.jpg",
                "mobile": "+923000000000",
                "designation": "Supervisor"
            },
            {
                "id": "1001676120",
                "name": "Mohsin Ali",
                "photo": null,
                "mobile": "+923000000000",
                "designation": null
            }
        ],
        "mobile": "+923000000000",
        "address": "C-63, Block 4, Opposite Bank Al Habib, Saadi Town, Scheme 33, Karachi.",
        "offices": [],
        "website": null,
        "whatsapp": "+923000000000",
        "listing_counts": {
            "rent": {
                "total": 12,
                "types": [
                    {
                        "type": "Lower Portions",
                        "count": 5
                    },
                    {
                        "type": "Houses",
                        "count": 4
                    },
                    {
                        "type": "Upper Portions",
                        "count": 2
                    },
                    {
                        "type": "Flats",
                        "count": 1
                    }
                ]
            },
            "sale": {
                "total": 46,
                "types": [
                    {
                        "type": "Houses",
                        "count": 43
                    },
                    {
                        "type": "Flats",
                        "count": 3
                    }
                ]
            }
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agency_agents"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "id": [
            "An agency id is required, e.g. 190203. Get one from the search endpoint (agency.id) or the agencies endpoint."
        ]
    },
    "message": "The request validation failed"
}
404

Agency Not Found

The agency id does not exist. This response is not billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false
    },
    "error": {
        "message": "The requested Zameen agency was not found. Check the agency id.",
        "failure_type": "agency_not_found"
    },
    "success": false
}
503

Temporarily Unavailable

Zameen did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": true
    },
    "error": {
        "message": "Zameen data is temporarily unavailable. Please retry.",
        "failure_type": "upstream_unavailable"
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.