Records
5 routes. Paths are relative to https://api.intersink.com/v1.
- GET/records/channels/{channelId}/{app}/{entity}List records (newest first; q searches every field)
- POST/records/channels/{channelId}/{app}/{entity}Create a record
- GET/records/channels/{channelId}/{app}/{entity}/{id}One record
- PATCH/records/channels/{channelId}/{app}/{entity}/{id}Update a record (merge)
- DELETE/records/channels/{channelId}/{app}/{entity}/{id}Delete a record
List records (newest first; q searches every field)
GET/records/channels/{channelId}/{app}/{entity}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| apprequired | string, path | |
| entityrequired | string, path | |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| q | string, query | Search in the title/name |
| status | string, query | Exact status value (e.g. Confirmed) At most 60 characters. |
Response
200. The payload in data is not described in the spec yet.
Create a record
POST/records/channels/{channelId}/{app}/{entity}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| apprequired | string, path | |
| entityrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| valuesrequired | object | Field values by key (the list's columns); null clears a field on update |
Response
201. The payload in data is not described in the spec yet.
One record
GET/records/channels/{channelId}/{app}/{entity}/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| apprequired | string, path | |
| entityrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Update a record (merge)
PATCH/records/channels/{channelId}/{app}/{entity}/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| apprequired | string, path | |
| entityrequired | string, path | |
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| valuesrequired | object | Field values by key (the list's columns); null clears a field on update |
Response
200. The payload in data is not described in the spec yet.
Delete a record
DELETE/records/channels/{channelId}/{app}/{entity}/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| apprequired | string, path | |
| entityrequired | string, path | |
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.