Skip to main content
GET
/
api
/
tenants
/
list
List or retrieve tenants
curl --request GET \
  --url https://api.propops.app/api/tenants/list \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "ID": 100,
    "uuid": "990e8400-e29b-41d4-a716-446655440001",
    "tenant_name": "Tenant_001",
    "tenant_email": "tenant001@example.com",
    "tenant_number_primary": "07700000003",
    "tenant_number_work": "01200000002",
    "address_id": 5,
    "full_address": "1 Example Street, Sample Town, EX1 1AA",
    "created_at": "2024-01-10T08:00:00Z"
  },
  "count": 80
}

Authorizations

​
Authorization
string
header
required

All API requests must include a valid Bearer token in the Authorization header. Tokens are 64-character SHA-256 session hashes issued by the PropOps authentication system.

Example:

Authorization: Bearer a1b2c3d4e5f6...

Query Parameters

​
action
enum<string>
required
Available options:
list,
get
​
uuid
string<uuid>
​
search
string
Example:

"Tenant_001"

​
address_id
integer
Example:

5

​
unassigned
boolean
Example:

false

​
active
boolean
Example:

true

​
limit
integer
default:50

Maximum number of records to return (default 50, max 200).

Required range: 1 <= x <= 200
​
offset
integer
default:0

Number of records to skip for pagination.

Required range: x >= 0

Response

Tenant list or single tenant

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"

​
data
object
​
count
integer
Example:

80