REST API for managing persons. The specification defines CRUD operations for creating, reading, updating, and deleting persons.
Base URL:
https://api.example.comPersons
Manage persons.
▶
GET
/persons
List persons
#
Retrieve a paginated list of persons.
Parameters
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| ▶q | string | query | Search query using field:value syntax. Multiple conditions separated by | |
| limit | integer | query | Maximum number of items to return (1-100). |
|
| offset | integer | query | Number of items to skip before collecting results. |
|
| ▶sort | string | query | Comma-separated list of fields to sort the response by. Prefix a field |
Responses
▶
POST
/persons
Create a person
#
Create a new person record.
Request body required
Responses
▶
GET
/persons/{personId}
Get a person
#
Retrieve a single person by identifier.
Parameters
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| personId | string | path | ✓ | Unique identifier of the person. |
Responses
▶
PATCH
/persons/{personId}
Update a person
#
Apply partial updates to an existing person.
Parameters
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| personId | string | path | ✓ | Unique identifier of the person. |
Request body required
Responses
▶
DELETE
/persons/{personId}
Delete a person
#
Permanently remove a person record.
Parameters
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| personId | string | path | ✓ | Unique identifier of the person. |
Responses