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.

GET POST PUT DELETE 5 Endpoints Auth Required
Base URL https://bogusapi.com/api/actors
GET /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.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /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.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique actor identifier
Response: 200 OK
GET /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.

Response: 404 Not Found
{}
POST /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.

Request Body
FieldTypeRequiredDescription
firstName string Required Actor's given name
lastName string Required Actor's family name
email string Required Unique email address
password string Required Plaintext password for the account
roleIds integer[] Optional IDs of roles to assign on creation
Body
Response: 201 Created
PUT /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.

Request Body
FieldTypeRequiredDescription
firstName string Required Updated first name
lastName string Required Updated last name
email string Required Updated email address
roleIds integer[] Optional New role assignment (replaces existing)
Body
Response: 200 OK
DELETE /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.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the actor to delete
Response: 204 No Content
{}