Get all custom object records

get

https://rls.congacloud.com/api/data/v1/custom-objects/{objectName}

Returns a list of all records for the given custom object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

objectName

string

required

Name of the custom object from which the records need to be fetched. It can only contain alphanumeric characters and underscores, and must have "_c" in the suffix.

For example: CustomObject_c.

Query Params

criteria

string

Search criteria for the object. For example: IsActive = 'true'.

Note: The criteria field (in this case, IsActive) must be indexed.

pageSize

int32

Number of records in each page. For example: 5 produces five records for each page.

pageNumber

int32

Number of pages to be fetched. For example: 2 fetches the second page with the number of records in the pageSize parameter.

Note: The page index starts at 1.

sortField

string

Field name for sorting. For example: FirstName.

Note: The sort field (in this case, FirstName) must be indexed or sortable.

sortDirection

string

enum

Sort direction for the data.

Allowed:

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

500Internal Server Error