Skip to main content
GET
List custom-object records

Authorizations

Authorization
string
header
required

An organization API key, created in Settings → Integrations → API keys. Keys start with mk_live_. Marro stores only a hash of a key, so it is shown once, when it is created: copy it then. Revoking a key ends its access at once. To replace a key without downtime, create the new one, switch your server to it, then revoke the old one. Changes made with a key appear on the lead’s timeline as made by the person who created the key, via the API. Scopes: objects.records.read (Read custom objects), objects.records.write (Create and update custom-object records), objects.records.delete (Delete custom-object records), leads.read (Read leads), leads.write (Create and update leads), leads.capture (Capture leads), crm.records.read (Read customers and opportunities), crm.records.write (Create and update customers and opportunities), reports.read (Read reports), money.read (Read products, quotes, invoices and payments), money.write (Create quotes and invoices and record payments), agent.tools (AI agent tools (MCP)).

Scopes

objects.records.read

Path Parameters

slug
string
required

The object’s immutable address, from List custom objects.

Pattern: ^[a-z][a-z0-9-]{0,47}$

Query Parameters

q
string

Words anywhere in the record name.

Maximum string length: 200
page
integer
Required range: 1 <= x <= 4000
pageSize
integer
Required range: 1 <= x <= 100
sort
string

created, updated, title, or field: for a sortable field.

Pattern: ^(created|updated|title|field:[a-z][a-z0-9_]{0,47})$
direction
enum<string>
Available options:
asc,
desc
archived
enum<string>
Available options:
true,
false
where
string
Maximum string length: 12000
cursor
string

nextCursor (or previousCursor with back=true) from the last page. Faster than page numbers for large objects.

Maximum string length: 400
Pattern: ^[A-Za-z0-9_-]+$
back
enum<string>
Available options:
true,
false
updated_since
string<date-time>

Only records changed at or after this time (ISO 8601), for keeping a copy in step.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

A scoped page.

object
object
required
items
object[]
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageSize
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991