Accessing CRUD objects through APIs
Get Objects
GET /{objects}&page=3&per_page=2&sort=desc:database_id
Parameters
| Name |
Type |
Description |
Required |
| per_page |
number |
Number of pages to return. |
no |
| page |
number |
Page number. |
no |
| sort |
string |
ascending (asc) or descending (desc) |
no |
| :sortvalue |
string |
column name to sort data with |
no |
Response
[
{
"database_id": "cd56b1e7-0082-499a-badb-6504634c7ac5",
"display_name": "Sam Winchester",
"email": "[email protected]",
"id": "sam.winchester",
"mailing_address": {
"address_1": "2506 Esperanza Court",
"address_2": "Apt. 15",
"city": "Lawrence",
"state": "KS",
"zip": 66049
},
"site_admin": 1
},
{
"database_id": "439549e1-87eb-4a8e-804a-1e8c4a33eb8d",
"display_name": "Buffy Summers",
"email": "[email protected]",
"id": "buffy.summers",
"mailing_address": {
"address_1": "11250 Angelico Lane",
"address_2": "Apt. 15",
"city": "Sunnyvale",
"state": "CA",
"zip": 66049
},
"site_admin": 0
}
]
Get specific object
GET /{objects}/:id
Parameters
| Name |
Type |
Description |
| :id |
string |
ID of object to return (ID is determined in yaml schema). |
Response
{
"database_id": "439549e1-87eb-4a8e-804a-1e8c4a33eb8d",
"display_name": "Buffy Summers",
"email": "[email protected]",
"id": "buffy.summers",
"mailing_address": {
"address_1": "11250 Angelico Lane",
"address_2": "Apt. 15",
"city": "Sunnyvale",
"state": "CA",
"zip": 66049
},
"site_admin": 0
}