List a module’s records

GET

/orgs/{org}/connectors/{id}/records/{module}

curl --request GET \
  --url 'https://api.sloose.com/orgs/org_9f3c/connectors/cnn_9f2a/records/Accounts?page=1&perPage=200' \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

One page of a module’s records, newest modified first — what a record picker reads as it first opens, and what tells the page whether a small module is whole (fewer than a page). Each record carries its id, the field its module’s records are named by (Zoho’s display_field) and $display_name, and nothing else: the CRM refuses a listing that names no fields, and this one names that field alone. Which field it is comes from the module’s own metadata, asked for the first time the module is read and kept. Read a whole record with GET …/records/{module}/{recordId}.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

id

required

The connector id, from GET /orgs/{org}/connectors.

string

Example

cnn_9f2a

The connector id, from GET /orgs/{org}/connectors.

module

required

The module’s API name in the destination.

string

Example

Accounts

The module’s API name in the destination.

Query Parameters

page

Page number, from 1.

string

Example

1

Page number, from 1.

perPage

Records per page. Default 200, max 200.

string

Example

200

Records per page. Default 200, max 200.

Responses

200

One page of records.

Media typeapplication/json

object

records

required

Array<object>

object

$display_name

Added by Sloose, not the CRM: the record’s name as the CRM shows it, read from the field its module names records by (Zoho’s display_field — Account_Name, Full_Name, Vendor_Name). Absent when that field is empty, and from a search or a single record when the field could not be learned just then.

string

key

additional properties

Example^generated

{
  "records": [
    {
      "$display_name": "example"
    }
  ]
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such connector, or it is not visible to this session (NOT_FOUND); or the connection has no module of that name — only its modules, as its discovery read them, are asked of the CRM (MODULE_NOT_FOUND).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

422

Zoho rejected the request.

Media typeapplication/json

object

error

required

string

zoho

required

object

code

required

string | null

status

required

number | null

details

retryable

required

boolean

response

unanswered

required

True when Zoho gave no answer that says what was done — the connection dropped or timed out, Zoho failed on its side (a 5xx, or the same for the one record inside a 2xx), the answer was lost after its status or was not JSON, or Zoho said it made the record without saying which — so what was asked may have been done all the same: a create sent again after one may make a second record. A write that went unanswered stays counted, and its row may be written again for nothing. False when Zoho answered by declining (a 4xx, or a per-record refusal inside a 2xx), which made nothing.

boolean

Example^generated

{
  "error": "example",
  "zoho": {
    "code": "example",
    "status": 1,
    "details": "example",
    "retryable": true,
    "response": "example",
    "unanswered": true
  }
}

502

Zoho is rate-limiting (zoho.unanswered false: nothing was done), or did not answer — it could not be reached, failed on its side, or answered without saying what it did (zoho.unanswered true: what was asked may have been done). Or this API could not use the connection before anything was sent — a Zoho token that will not refresh (code: CONNECTION_UNAVAILABLE) — and says so on a write with written: false: nothing was written.

Media typeapplication/json

Any of:

object

object

error

required

string

zoho

required

object

code

required

string | null

status

required

number | null

details

retryable

required

boolean

response

unanswered

required

True when Zoho gave no answer that says what was done — the connection dropped or timed out, Zoho failed on its side (a 5xx, or the same for the one record inside a 2xx), the answer was lost after its status or was not JSON, or Zoho said it made the record without saying which — so what was asked may have been done all the same: a create sent again after one may make a second record. A write that went unanswered stays counted, and its row may be written again for nothing. False when Zoho answered by declining (a 4xx, or a per-record refusal inside a 2xx), which made nothing.

boolean

object

object

error

required

string

code

required

Why: CONNECTION_UNAVAILABLE when a Zoho token for the connection will not refresh.

string

written

On a write: refused before the record was sent to the CRM, so nothing was written and a retry makes no second record. Absent from a read.

boolean

key

additional properties

Example

{
  "written": false
}