Skip to main content
GET
/
api
/
admin
/
branches
List branches
curl --request GET \
  --url https://my.propops.app/api/admin/branches \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": [
    {
      "ID": 1,
      "branch_name": "Branch_001",
      "address_line_1": "10 Office Road",
      "city": "Sample City",
      "postcode": "SC1 1AA",
      "contact_number": "01200000001",
      "shared_email": "branch001@example.com",
      "is_active": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://help.propops.app/llms.txt

Use this file to discover all available pages before exploring further.

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,
download_template
​
search
string
Example:

"Branch_001"

​
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

Branch list or CSV template

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"

​
data
object[]