List records by schema

{ "records": [ { "id": "1fba439a-208e-48e6-bd23-f6c97c3e0519", "externalId": "test-obj-1", "schemaId": "6449c3f3-b68d-46d1-850b-c8aea998ce1b", "fields": [ { "id": "my-number-field", "value": 100 } ], "relationships": { "primary-contact": [ "14" ] }, "createdTimestamp": "2021-04-16T16:12:22.222685095Z", "updatedTimestamp": "2021-04-16T16:13:12.022671090Z" } ], "meta": { "total": 1, "count": 1, "limit": 20, "offset": 0 } }

Note: Only admin users are allowed to run this endpoint without a filter parameter. All other users must filter by a specific contact, account, or deal.

If a schema has been defined with a relationship to an account with a schema id 2123028c-64e6-40e2-97bc-9d63a2ca920b and account id 123, the request would look like the following.

https://youraccountname.api-us1.com/api/3/customObjects/records/2123028c-64e6-40e2-97bc-9d63a2ca920b?filters[relationships.account][eq]=123

If a schema has been defined with a relationship to a deal with a schema id 2123028c-64e6-40e2-97bc-9d63a2ca920b and deal id 22, the request would look like the following.

https://youraccountname.api-us1.com/api/3/customObjects/records/2123028c-64e6-40e2-97bc-9d63a2ca920b?filters[relationships.deal][eq]=22

If a schema has been defined with a relationship to a contact with a schema id 2123028c-64e6-40e2-97bc-9d63a2ca920b and contact id 55, the request would look like the following.

https://youraccountname.api-us1.com/api/3/customObjects/records/2123028c-64e6-40e2-97bc-9d63a2ca920b?filters[relationships.primary-contact][eq]=55

Click here for more information on paging, ordering, sorting, and filtering.

Path Params
string
required

ID of schema

Query Params
int32
Defaults to 20

The number of records to return for each call. Maximum value is 100.

int32
Defaults to 0

Offset index of records to return

filters
array of strings

Use ?filters[relationships.{your-contact-relationship}][eq]={contactId} to filter records to a specific contact.

filters
Responses

Language
Credentials
URL
Choose an example:
application/json
text/plain