Get agency | Alsona | API Documentation

Retrieve agency details.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

agency_idstringRequired

Query parameters

specific_attributesstringOptional

Comma-separated list of attributes to return. Any combination of: accounts, agency_id, active_until, name, seats_assigned, seats_paid, seats_used, status, stripe_customer_id, subscription_status, created_at, created_by.

Comma-separated list of attributes to return. Any combination of: `accounts`, `agency_id`, `active_until`, `name`, `seats_assigned`, `seats_paid`, `seats_used`, `status`, `stripe_customer_id`, `subscription_status`, `created_at`, `created_by`.

Response

Successful response

successboolean

agencyobject

1	{
2	"success": true,
3	"agency": {
4	"accounts": [
5	"ACCO1XXXXXXXXXXXXXXXXXXX",
6	"ACCO2XXXXXXXXXXXXXXXXXXX"
7	],
8	"agency_id": "AGENXXXXXXXXXXXXXXXXXXXX",
9	"active_until": "2026-03-20",
10	"name": "My Account Agency",
11	"seats_assigned": 4,
12	"seats_paid": 4,
13	"seats_used": 1,
14	"status": "ENABLED",
15	"subscription_status": "active",
16	"created_at": 1763554329086,
17	"created_by": "john.doe@example.com"
18	}
19	}

1	curl https://alsona.com/rest/agency/agency_id \
2	-H "X-API-KEY: <apiKey>"