Admin API

A comprehensive RESTful API for managing your Admin workspace, users, projects, and analytics. All requests are made over HTTPS and return JSON responses.

Base URL

https://api.admin.com/v2/

Authentication

Authenticate your API requests using Bearer tokens. Include your API key in the Authorization header:

HTTP Header

Authorization: Bearer your_api_key_here

Generate your API key from the Settings > API Keys section of your Admin dashboard. Keep your keys secure and never expose them in client-side code.

Users API

Manage team members, roles, and permissions.

GET /users List all users

Returns a paginated list of users in your workspace.

Parameter	Type	Required	Description
`page`	integer	—	Page number (default: 1)
`limit`	integer	—	Items per page (default: 20, max: 100)
`role`	string	—	Filter by role: `admin`, `member`, `viewer`

Response
{
  "data": [
    {
      "id": "usr_8x72k9",
      "email": "sarah@example.com",
      "role": "admin",
      "created_at": "2024-01-15T08:30:00Z",
      "status": "active"
    }
  ],
  "meta": {
    "page": 1,
    "total": 42,
    "limit": 20
  }
}

POST /users Create a user

Invite a new member to your workspace.

Parameter	Type	Required	Description
`email`	string	Required	User email address
`role`	string	Required	Assigned role
`name`	string	—	Full name

Request Body
{
  "email": "mike@example.com",
  "role": "member",
  "name": "Mike Chen"
}

Projects API

Full lifecycle management for your projects.

GET /projects/{id} Get project details

Retrieve comprehensive details for a specific project.

Parameter	Type	Required	Description
`id`	string	Required	Project identifier

Response
{
  "id": "prj_99a2b1",
  "name": "Q3 Marketing Campaign",
  "status": "active",
  "owner_id": "usr_8x72k9",
  "created_at": "2024-03-10T14:22:00Z",
  "settings": {
    "privacy": "team",
    "notifications": true
  }
}

DELETE /projects/{id} Delete a project

Permanently removes a project. This action cannot be undone.

Response
{ "success": true, "message": "Project deleted successfully" }

Interactive Console

Test endpoints directly from your browser. Your API key is stored securely in local storage.

Waiting for request...

Error Handling

Admin uses standard HTTP status codes. Error responses include a machine-readable code and human-readable message.

Code	Status	Description
`400`	Bad Request	Malformed request or missing parameters
`401`	Unauthorized	Invalid or missing API key
`403`	Forbidden	Insufficient permissions
`404`	Not Found	Resource does not exist
`429`	Too Many Requests	Rate limit exceeded
`500`	Internal Error	Unexpected server error