Version: 1
| Operation | Description |
|---|---|
| GET /{applicationId}/collections/{collectionId}/records | List records |
| POST /{applicationId}/collections/{collectionId}/records | Create a record or records |
| PUT /{applicationId}/collections/{collectionId}/records | Update many records |
| DELETE /{applicationId}/collections/{collectionId}/records | Delete records |
| PATCH /{applicationId}/collections/{collectionId}/records/upsert/{upsertKeyColumnId} | Upsert a record or records |
| GET /{applicationId}/collections/{collectionId}/records/{recordId} | Get a record |
| PUT /{applicationId}/collections/{collectionId}/records/{recordId} | Update a record |
| DELETE /{applicationId}/collections/{collectionId}/records/{recordId} | Delete a record |
| Operation | Description |
|---|---|
| POST /{applicationId}/collections/{collectionId}/attachments | Create an attachment |
| GET /{applicationId}/collections/{collectionId}/attachments/{attachmentId} | Get an attachment |
| Operation | Description |
|---|---|
| GET /{applicationId}/users | List users |
| POST /{applicationId}/users/{userId}/notifications | Send a push notification |
| Operation | Description |
|---|---|
| GET /{applicationId} | Get an application definition |
| Operation | Description |
|---|---|
| GET /{applicationId}/management/users | List users |
| POST /{applicationId}/management/users | Create a user |
| GET /{applicationId}/management/users/{userId} | Get a user |
| PUT /{applicationId}/management/users/{userId} | Update a user |
| DELETE /{applicationId}/management/users/{userId} | Delete a user |
Bearer authentication. Use the concatenation of your token ID and your secret token, using the character ., as bearer token.
Basic authentication. Use your user ID as a username, and use your password as a password.
Get an application definition with collection and column definitions.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ |
application/json
An application definition was fetched. A response body contains the application definition.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Create an attachment in a specified collection.
*/*
A body must be a binary stream of an attachment.
A binary stream of an attachment.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| Content-Disposition | Content-Disposition of the attachment. If it contains |
header | string | |
| Content-Type | Content-Type of the attachment. |
header | string application/octet-stream | |
| X-Platio-CreatorId | A User to be used as a creator of the attachment. You have to be an admin user to specify this parameter. You'll be a creator if you don't specify this parameter. |
header | string , must match ^u[a-z0-9]{7}$ |
application/json
An attachment was created. A response body contains metadata of the created attachment.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Get an attachment specified by its ID in a specified collection.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| attachmentId | ID of an attachment. |
path | string , must match ^a[a-z0-9]{26}$ |
*/*
The attachment was fetched. A response body contains a binary stream of the attachment.
| Cache-Control | string | |
| ETag | string | |
| Last-Modified | string | |
| Content-Type | string | |
| Content-Disposition | string |
The attachment has not modified.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Delete records in a specified collection. You can specify some parameters to control which records are deleted.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| search | Query to search. For instance |
query | string | |
| timezone | Timezone of the dates in the search query from the tz database, for instance |
query | string The application's timezone | |
| limit | Maximum number of records to delete. |
query | integer , { x ∈ ℤ | x ≤ 100000 } 100000 |
The records were deleted (when you specify limit).
{
"deletedCount": 3453
}
The number of deleted records.
The records were deleted (when you don't specify limit).
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
List records in a specified collection. You can specify some parameters to control which records are listed.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| skip | Number of records to skip. |
query | integer | |
| limit | Number of records to return. |
query | integer , { x ∈ ℤ | x ≤ 100 } 100 | |
| sortKey | Key of the sort. |
query | string , x ∈ { column , createdAt , updatedAt (default) , createdBy , updatedBy } | |
| sortOrder | Order of the sort. |
query | string , x ∈ { ascending , descending (default) } | |
| sortColumnId | ID of a column to sort records by. This is required when |
query | string , must match ^c[a-z0-9]{7}$ | |
| search | Query to search. For instance |
query | string | |
| timezone | Timezone of the dates in the search query from the tz database, for instance |
query | string The application's timezone |
application/json
Records were fetched. A response body contains the array of records.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Create a record or records with specified values in a specified collection.
application/json
A body must be a JSON object or a JSON array containing parameters to create a record or records.
An object containing parameters to create a record, or an array of objects of this scheme to create records.
{
"creatorId": "ue66a6a4",
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
}
Mapping from column IDs / values. Visit https://doc.plat.io/api/en/values.html for details.
A User to be used as a creator of the record. You have to be an admin user to specify this parameter. You'll be a creator if you don't specify this parameter.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ |
application/json
A record or records were created. A response body contains the created record or the list of created records.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Update many records in a specified collection with specified values.
application/json
A body must be a array of objects containing parameters to update many records.
An object containing parameters to update a record.
[
{
"id": "rwyfzcbdj2vb5rbsebyp3f42zvi",
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
},
{
"id": "refo5otf6fbb2lhgnwvhbc7jg5i",
"replace": false,
"values": {
"c3838801": {
"id": "u77e8bc9",
"name": "user1",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": false
},
"cb9585ae": {
"type": "Date",
"value": "2019-09-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value 2"
}
}
}
]
ID of a record.
Mapping from column IDs / values. Visit https://doc.plat.io/api/en/values.html for details.
A flag specifying whether replacing all values. Only values specified by values will be updated if false. Specify null to delete a value in values. All values are updated otherwise.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ |
application/json
The records were updated. A response body contains the list of updated records.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Updates a record that has the same value for the specified column. It creates a new record when no record is found.
A body must be a JSON object containing parameters to create a record. Or it can be a JSON array containing objects in this scheme.
An object containing parameters to create a record.
{
"creatorId": "ue66a6a4",
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
}
Mapping from column IDs / values. Visit https://doc.plat.io/api/en/values.html for details.
A User to be used as a creator of the record. You have to be an admin user to specify this parameter. You'll be a creator if you don't specify this parameter.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| upsertKeyColumnId | ID of a column that will be used to search for a record. A specified column should be unique and searchable. |
path | string , must match ^c[a-z0-9]{7}$ |
application/json
A record or records were userted. A response body contains the upserted record or the list of upserted records.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Delete a specified record in a specified collection.
| applicationId | Id of the application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | Id of the collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| recordId | Id of the record. |
path | string , must match ^r[a-z0-9]{26}$ |
The record was deleted.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Get a record specified by its id in a specified collection.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| recordId | ID of a record. |
path | string , must match ^r[a-z0-9]{26}$ |
application/json
A record was fetched. A response body contains the record.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Update a specified record in a specified collection with specified values.
application/json
A body must be a JSON object containing parameters to update a record.
An object containing parameters to update a record.
{
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
}
Mapping from column IDs / values. Visit https://doc.plat.io/api/en/values.html for details.
A flag specifying whether replacing all values. Only values specified by values will be updated if false. Specify null to delete a value in values. All values are updated otherwise.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| collectionId | ID of a collection. |
path | string , must match ^t[a-z0-9]{7}$ | |
| recordId | ID of a record. |
path | string , must match ^r[a-z0-9]{26}$ |
application/json
The record was updated. A response body contains the updated record.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
List users in a specified application. Contains more information pertinent to management API operations than /{applicationId}/users.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| skip | Number of users to skip. |
query | integer | |
| limit | Number of users to return. |
query | integer , { x ∈ ℤ | x ≤ 100 } 100 | |
| search | Query to search. Users whose names, email addresses, profile name or team name (if your application has enabled Team mode) contain a specified query string in case-sensitive manner. |
query | string |
application/json
Users were fetched. A response body contains the array of users.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Create a user in a specified application. Alternatively, if your organization is in Shared Users mode, activates a Shared User in the specified application.
application/json
A body must be a JSON object containing parameters to create a user.
An object containing parameters to create a user.
{
"admin": false,
"apiAccess": true,
"email": "user1@example.com",
"managementApiAccess": false,
"name": "user1",
"password": "Password1",
"profile": {
"name": "Default"
},
"team": {
"name": "Default"
},
"teamLeader": false
}
The name of the user to be created. If your Organization has enabled Shared Users mode, passing a name that doesn't match an existing Shared User will cause the request to fail. Otherwise, any unused name can be used. This property should not be empty, should be 64 characters long at most, and should not start with "_".
The email to give to a user. Required if your Organization has not enabled Shared Users mode. Passing this property when Shared Users mode is enabled will cause the request to fail.
The password a user will use to login. Required if your Organization has not enabled Shared Users mode. Passing this property when Shared Users mode is enabled will cause the request to fail. This property should be a minimum of 8 characters long and should contain at least one of each of the following: a lowercase character, an uppercase character and a number.
Whether the user to be created should be an admin or not.
Whether the user to be created should have Platio API access or not.
Whether the user to be created should have Management API access or not. Requires apiAccess to also be true.
The profile to assign to the user.
The team to assign to a user. Required if your application has Team mode enabled. Passing this property when Team mode is disabled will cause the request to fail.
Whether the user should be a team leader. Required if your application has Team mode enabled. Passing this property when Team mode is disabled will cause the request to fail.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ |
application/json
A user was created. A response body contains the created user.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Delete a user in a specified application. Not available if your organization is in Shared Users mode.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| userId | ID of a user. |
path | string , must match ^u[a-z0-9]{7}$ |
application/json
A user was deleted. A response is empty.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
A user wasn't found.
The specified HTTP verb is not allowed. Your organization may be in Shared Users mode.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Get a user from a specified application. Contains more information pertinent to management API operations than /{applicationId}/users.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| userId | ID of a user. |
path | string , must match ^u[a-z0-9]{7}$ |
application/json
A user was fetched. A response body contains the user.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
A user wasn't found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Update a user in a specified application.
application/json
A body must be a JSON object containing parameters to create a user.
An object containing parameters to create a user.
The new email to give to a user. Required if your organization does not have Shared Users mode enabled. Passing this property when Shared Users mode is enabled will cause the request to fail.
The new password a user will use to login. Passing this property when Shared Users mode is enabled will cause the request to fail.
Whether the user to be updated should be an admin or not.
Whether the user to be updated should have Platio API access or not.
Whether the user to be updated should have Management API access or not. Requires apiAccess to also be true.
The profile to assign to the user.
The team to assign to a user. Required if your application has Team mode enabled. If your application is not in Team mode, passing this property will cause the request to fail.
Whether the user should be a team leader. Required if your application has Team mode enabled. If your application is not in Team mode, passing this property will cause the request to fail.
Update the state of a user. If a user is not disabled, they can login to Data Pockets in the specified Application. If disabled, the user can no longer login.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| userId | ID of a user. |
path | string , must match ^u[a-z0-9]{7}$ |
application/json
A user was updated. A response body contains the updated user.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
A user wasn't found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
List users sorted by their names in ascending order.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| skip | Number of users to skip. |
query | integer | |
| limit | Number of users to return. |
query | integer , { x ∈ ℤ | x ≤ 100 } 100 | |
| search | Query to search. Users whose names contain a specified query string in case-sensitive manner match. |
query | string |
application/json
Users were fetched. A response body contains the array of users.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
Send a push notification to a user. Make sure to configure your application to enable push notifications. Also you must be an admin of the MiniApp to send push notifications.
A body must be a JSON object containing parameters to post a notification.
An object containing parameters to post a notification.
{
"body": "The temperature is too high.",
"sound": "default",
"title": "Warning!"
}
A title of the notification.
A body of the notification.
A url to be opened when a user taps the notification. You can use Platio URL to open a Data Pocket or a Record. Visit https://doc.plat.io/api/en/url.html for details.
Specify default to play a sound. Omit this property or specify an empty string not to play a sound.
| applicationId | ID of an application. |
path | string , must match ^p[a-z0-9]{26}$ | |
| userId | ID of a user. |
path | string , must match ^u[a-z0-9]{7}$ |
application/json
Sent a notification to a user. The user may not receive the notification if they haven't allow Platio App to receive it.
Some of the parameters are invalid.
Failed to authenticate a user.
A specified request is forbidden.
Some of the resources are not found.
You reached the maximum number of requests in a certain period.
Something went wrong on the server.
| Bearer | |
| Basic |
{
"collections": [
{
"columns": [
{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": true
},
{
"id": "cda200dd",
"name": "Image",
"searchable": false,
"sortable": false,
"type": "Attachment",
"unique": false
}
],
"id": "t3ec0e55",
"name": "Author",
"readAccessType": "everyone",
"writeAccessType": "creatorOnly"
},
{
"columns": [
{
"id": "ce5ca799",
"name": "ID",
"searchable": true,
"sortable": false,
"type": "Number",
"unique": true
},
{
"id": "c45870e3",
"name": "Title",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
},
{
"id": "cf8fe3f1",
"name": "Reference Author Name",
"scheme": {
"collectionId": "t3ec0e55",
"columnId": "c785eb1d"
},
"searchable": true,
"sortable": true,
"type": "ReferenceString",
"unique": false
}
],
"id": "t4395e79",
"name": "Book",
"readAccessType": "everyone",
"writeAccessType": "everyone"
}
],
"id": "pahmahtftzbhmdpu2eim3xytzdy",
"name": "Library",
"sharedUsersModeEnabled": false,
"teamsModeEnabled": false,
"url": "https://app.plat.io/app/Demo/Library",
"version": 14
}
An ID of an application.
A name of an application.
A version of an application.
A flag specifying whether shared users mode is enabled.
A flag specifying whether team mode is enabled.
A URL to an application.
An array of collections.
{
"contentType": "image/jpeg",
"id": "amghzojy2nfctzmqy43aflu3xpe",
"name": "image.jpg",
"size": 4151345
}
An ID of an attachment.
A name of an attachment.
Content-Type of an attachment.
Size of an attachment.
{
"columns": [
{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
},
{
"id": "cda200dd",
"name": "Image",
"searchable": false,
"sortable": false,
"type": "Attachment",
"unique": false
},
{
"id": "c4127d81",
"name": "Accelerometer (BlueNinja)",
"scheme": {
"keys": [
{
"name": "x",
"type": "Number"
},
{
"name": "y",
"type": "Number"
},
{
"name": "z",
"type": "Number"
}
]
},
"searchable": false,
"sortable": false,
"type": "Object",
"unique": false
}
],
"id": "t3ec0e55",
"name": "Collection 1",
"readAccessType": "everyone",
"writeAccessType": "creatorOnly"
}
An ID of a collection.
A name of a collection.
A read access type of a collection.
A write access type of a collection.
An array of columns.
{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
}
An ID of a column.
A name of a column.
A type of a column. Visit https://doc.plat.io/api/en/values.html for more details.
A scheme of a column. It contains collectionId and columnId properties for the Reference types. For Object type, it has keys property, and this property is an array and each item is an object with name and type properties. For Array type, it has element property, and this property has type property and an optional scheme property. For the other types, this property won't exist. Visit https://doc.plat.io/api/en/values.html for more details.
true if values of this column must be unique in a collection. false otherwise.
true if records can be sorted by values of this column. false otherwise.
true if records can be searched by values of this column. false otherwise.
{
"code": "INVALID_APPLICATION_ID"
}
An error code.
Additional information of an error.
{
"admin": false,
"apiAccess": true,
"disabled": false,
"email": "user1@example.com",
"id": "u1a2b3c4",
"managementApiAccess": true,
"name": "user1",
"profile": {
"name": "Profile 1"
},
"team": {
"name": "Team A"
},
"teamLeader": true
}
The ID of the user.
The name of the user.
The email of the user.
Whether or not the user is an admin.
Whether or not the user has API access.
Whether or not the user has management API access.
An object describing the user's assigned profile
The name of the user's profile.
An object describing the user's assigned team. Only present when getting a user in Team mode applications.
The name of the user's team.
Whether or not the user is a team leader. Only present when getting a user in Team mode applications.
Whether or not the user is disabled.
{
"createdAt": "2017-03-13T02:18:14.500Z",
"createdBy": {
"id": "u11bbc2c",
"name": "user1"
},
"hash": "10dd94a465266c4cd0bca9e1481845d9b9074b42",
"id": "rwyfzcbdj2vb5rbsebyp3f42zvi",
"timestamp": "2017-03-13T02:18:14.519Z",
"updatedAt": "2017-03-13T02:18:14.500Z",
"updatedBy": {
"id": "u11bbc2c",
"name": "user1"
},
"values": {
"c88a7152": {
"type": "Number",
"value": 124356
},
"cc864ba9": {
"type": "String",
"value": "string value"
}
}
}
An ID of a record.
Mapping from column IDs to values. An ID of a column without a value won't be included when you get a record.
A hash of a record.
A timestamp of a record.
Created time of a record.
A creator of a record.
Updated time of record.
An updator of a record.