processmaker.comKnowledge CenterProcessMaker University

Collections

Returns all collections that the user has access to

get

Get a list of Collections.

Authorizations
Query parameters
filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

Include data from related models in payload. Comma separated list.

Default: ""
Responses
200
list of collections
application/json
get
GET /api/1.0/collections HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of collections

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "custom_title": "text",
      "create_screen_id": "text",
      "read_screen_id": "text",
      "update_screen_id": "text",
      "signal_create": true,
      "signal_update": true,
      "signal_delete": true,
      "id": 1,
      "created_at": "2025-07-04T19:36:32.894Z",
      "updated_at": "2025-07-04T19:36:32.894Z",
      "created_by_id": "text",
      "updated_by_id": "text",
      "columns": [
        {}
      ]
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new collections

post

Create a new Collection.

Authorizations
Body
namestringOptional
descriptionstringOptional
custom_titlestringOptional
create_screen_idstring · idOptional
read_screen_idstring · idOptional
update_screen_idstring · idOptional
signal_createbooleanOptional
signal_updatebooleanOptional
signal_deletebooleanOptional
Responses
201
success
application/json
Responseall of
post
POST /api/1.0/collections HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true
}
201

success

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true,
  "id": 1,
  "created_at": "2025-07-04T19:36:32.894Z",
  "updated_at": "2025-07-04T19:36:32.894Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": [
    {}
  ]
}

Get single collections by ID

get

Get a single Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection to return

Responses
200
Successfully found the collections
application/json
Responseall of
get
GET /api/1.0/collections/{collection_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Successfully found the collections

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true,
  "id": 1,
  "created_at": "2025-07-04T19:36:32.894Z",
  "updated_at": "2025-07-04T19:36:32.894Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": [
    {}
  ]
}

Update a collection

put

Update a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection to update

Body
namestringOptional
descriptionstringOptional
custom_titlestringOptional
create_screen_idstring · idOptional
read_screen_idstring · idOptional
update_screen_idstring · idOptional
signal_createbooleanOptional
signal_updatebooleanOptional
signal_deletebooleanOptional
Responses
204
success
put
PUT /api/1.0/collections/{collection_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true
}
204

success

No content

Delete a collection

delete

Delete a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection to return

Responses
204
success
delete
DELETE /api/1.0/collections/{collection_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

No content

Trigger export collections job

post

Export the specified collection.

Authorizations
Path parameters
collection_idstringRequired

ID of the collection to export

Responses
202
success
post
POST /api/1.0/collections/{collection_id}/export HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
202

success

No content

Import a new collection

post

Import the specified collection.

Authorizations
Body
filefile · fileRequired

file to upload

Responses
200
success
post
POST /api/1.0/collections/import HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 13

{
  "file": null
}
No content

Deletes all records in a collection

delete

Truncate a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection to truncate

Responses
204
success
delete
DELETE /api/1.0/collections/{collection_id}/truncate HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

No content

Returns all records

get

Get the list of records of a collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection to get records for

Query parameters
pmqlstringOptional
per_pageintegerOptionalDefault: 10
filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
includestringOptional

Include data from related models in payload. Comma separated list.

Default: ""
Responses
200
list of records of a collection
application/json
get
GET /api/1.0/collections/{collection_id}/records HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of records of a collection

{
  "data": [
    {
      "data": {},
      "id": 1,
      "collection_id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new record in a collection

post

Create a new record in a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of the collection

Body
dataobjectOptional
Responses
201
success
application/json
Responseall of
post
POST /api/1.0/collections/{collection_id}/records HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "data": {}
}
201

success

{
  "data": {},
  "id": 1,
  "collection_id": "text"
}

Get single record of a collection

get

Get a single record of a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of the collection

record_idstringRequired

ID of the record to return

Responses
200
Successfully found the record
application/json
Responseall of
get
GET /api/1.0/collections/{collection_id}/records/{record_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Successfully found the record

{
  "data": {},
  "id": 1,
  "collection_id": "text"
}

Update a record

put

Update a record in a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection

record_idstringRequired

ID of the record

Body
dataobjectOptional
Responses
204
success
put
PUT /api/1.0/collections/{collection_id}/records/{record_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "data": {}
}
204

success

No content

Delete a collection record

delete

Delete a record of a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection

record_idstringRequired

ID of record in collection

Responses
204
success
delete
DELETE /api/1.0/collections/{collection_id}/records/{record_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

No content

Partial update of a record

patch

Implements a partial update of a record in a Collection.

Authorizations
Path parameters
collection_idstringRequired

ID of collection

record_idstringRequired

ID of the record

Body
namestringOptional
descriptionstringOptional
custom_titlestringOptional
create_screen_idstring · idOptional
read_screen_idstring · idOptional
update_screen_idstring · idOptional
signal_createbooleanOptional
signal_updatebooleanOptional
signal_deletebooleanOptional
Responses
200
success
patch
PATCH /api/1.0/collections/{collection_id}/records/{record_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true
}
200

success

No content
PreviousData ConnectorsNextDecision Engine

Last updated