Actors API
v1.0 • REST • JSON
Full CRUD management for actor accounts. Create, retrieve, update, and delete actor records with built-in pagination and role-based access control support.
Quick Reference
/api/actors
200 OK
Get All Actors
Retrieves a paginated list of all actors in the system. Use the page
and limit query parameters to navigate large result sets.
The response envelope includes total count and page metadata.
| Parameter | Type | Default | Description |
|---|---|---|---|
page |
integer | 1 |
Page number, 1-based index |
limit |
integer | 10 |
Number of records per page |
/api/actors/{id}
200 OK
Get Single Actor
Fetch the full profile for a specific actor using their numeric ID. Returns all actor fields including assigned role names and account metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Unique actor identifier |
/api/actors/{id}
404 Not Found
Actor Not Found
Returned when the requested actor ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing actor resources.
/api/actors
201 Created
Create Actor
Registers a new actor with the provided details. On success, returns the newly created actor object including the auto-generated ID, timestamp, and resolved role names.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
description |
string | Optional | Description |
nationality |
string | Required | Nationality |
birthDate |
datetime | Required | Birth date |
knownFor |
string | Required | Known for |
awardsCount |
integer | Required | Awards count |
isActive |
boolean | Required | Is active |
/api/actors/{id}
200 OK
Update Actor
Fully replaces an existing actor's data with the values in the request body. A successful update returns 200 OK with response body.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
description |
string | Optional | Description |
nationality |
string | Required | Nationality |
birthDate |
datetime | Required | Birth date |
knownFor |
string | Required | Known for |
awardsCount |
integer | Required | Awards count |
isActive |
boolean | Required | Is active |
/api/actors/{id}
204 No Content
Delete Actor
Permanently removes a actor from the system by their ID. This action is irreversible once deleted, the actor record and all associated data cannot be recovered through the API.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | ID of the actor to delete |