Documentation Index

Fetch the complete documentation index at: https://docs.processmaker.com/llms.txt

Use this file to discover all available pages before exploring further.

Get single collections by ID

Prev Next
Get
/collections/{collection_id}

Get a single Collection.

Security
OAuth

Laravel passport oauth2 security.

FlowAuthorization Code
Authorization URLhttps://develop-qa.processmaker.net/oauth/authorize
Token URLhttps://develop-qa.processmaker.net/oauth/token
Refresh URLhttps://develop-qa.processmaker.net/token/refresh
Path parameters
collection_id
stringRequired

ID of collection to return

per_page Parameter

The GET /collections/{collection_id}/records endpoint supports configurable pagination through the per_page parameter.

Default Pagination Behavior

If no valid per_page value is provided, the endpoint automatically applies a default pagination limit. This behavior prevents accidental unbounded queries and helps reduce excessive memory consumption or performance impact when querying large collections.

Explicit Pagination Requests

When a valid per_page value is explicitly provided, the endpoint returns up to the requested number of records.

Example:

GET /collections/{collection_id}/records?per_page=2000

If the collection contains enough records, the response returns up to 2,000 records.

Responses
200

Successfully found the collections

Expand All
object
name
string
description
string
custom_title
string
create_screen_id
string (id)
read_screen_id
string (id)
update_screen_id
string (id)
signal_create
boolean
signal_update
boolean
signal_delete
boolean
id
integer
created_at
string (date-time)
updated_at
string (date-time)
created_by_id
string (id)
updated_by_id
string (id)
columns
Array of object
object