# Records (*records*) ## Overview Records are individual instances of objects e.g. a specific [person](/docs/standard-objects-people) or [company](/docs/standard-objects-companies). See our [data model guide](/docs/data-model) for more information. ### Available Operations * [query](#query) - List records * [create](#create) - Create a record * [assert](#assert) - Assert a record * [get](#get) - Get a record * [partialUpdate](#partialupdate) - Update a record (append multiselect values) * [update](#update) - Update a record (overwrite multiselect values) * [delete](#delete) - Delete a record * [listAttributeValues](#listattributevalues) - List record attribute values * [listEntries](#listentries) - List record entries ## query Lists people, company or other records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.query({ object: "people", requestBody: { filter: { "name": "Ada Lovelace", }, sorts: [ { direction: "asc", attribute: "name", field: "last_name", }, ], limit: 500, offset: 0, }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsQuery } from "attio-js/funcs/recordsQuery.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsQuery(attio, { object: "people", requestBody: { filter: { "name": "Ada Lovelace", }, sorts: [ { direction: "asc", attribute: "name", field: "last_name", }, ], limit: 500, offset: 0, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostV2ObjectsObjectRecordsQueryRequest](../../models/operations/postv2objectsobjectrecordsqueryrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PostV2ObjectsObjectRecordsQueryResponse](../../models/operations/postv2objectsobjectrecordsqueryresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | errors.FilterError | 400 | application/json | | errors.PostV2ObjectsObjectRecordsQueryNotFoundError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## create Creates a new person, company or other record. This endpoint will throw on conflicts of unique attributes. If you would prefer to update records on conflicts, please use the [Assert record endpoint](/reference/put_v2-objects-object-records) instead. Required scopes: `record_permission:read-write`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.create({ object: "people", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsCreate } from "attio-js/funcs/recordsCreate.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsCreate(attio, { object: "people", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostV2ObjectsObjectRecordsRequest](../../models/operations/postv2objectsobjectrecordsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PostV2ObjectsObjectRecordsResponse](../../models/operations/postv2objectsobjectrecordsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | errors.PostV2ObjectsObjectRecordsInvalidRequestError | 400 | application/json | | errors.GetV2ObjectsObjectNotFoundError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## assert Use this endpoint to create or update people, companies and other records. A matching attribute is used to search for existing records. If a record is found with the same value for the matching attribute, that record will be updated. If no record with the same value for the matching attribute is found, a new record will be created instead. If you would like to avoid matching, please use the [Create record endpoint](/reference/post_v2-objects-object-records). If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values. Required scopes: `record_permission:read-write`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.assert({ object: "people", matchingAttribute: "41252299-f8c7-4b5e-99c9-4ff8321d2f96", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsAssert } from "attio-js/funcs/recordsAssert.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsAssert(attio, { object: "people", matchingAttribute: "41252299-f8c7-4b5e-99c9-4ff8321d2f96", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutV2ObjectsObjectRecordsRequest](../../models/operations/putv2objectsobjectrecordsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PutV2ObjectsObjectRecordsResponse](../../models/operations/putv2objectsobjectrecordsresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | | errors.PutV2ObjectsObjectRecordsInvalidRequestError | 400 | application/json | | errors.GetV2ObjectsObjectNotFoundError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## get Gets a single person, company or other record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.get({ object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsGet } from "attio-js/funcs/recordsGet.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsGet(attio, { object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetV2ObjectsObjectRecordsRecordIdRequest](../../models/operations/getv2objectsobjectrecordsrecordidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetV2ObjectsObjectRecordsRecordIdResponse](../../models/operations/getv2objectsobjectrecordsrecordidresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | errors.GetV2ObjectsObjectRecordsRecordIdInvalidRequestError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## partialUpdate Use this endpoint to update people, companies, and other records by `record_id`. If the update payload includes multiselect attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the `PUT` endpoint to overwrite or remove multiselect attribute values. Required scopes: `record_permission:read-write`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.partialUpdate({ object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsPartialUpdate } from "attio-js/funcs/recordsPartialUpdate.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsPartialUpdate(attio, { object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PatchV2ObjectsObjectRecordsRecordIdRequest](../../models/operations/patchv2objectsobjectrecordsrecordidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PatchV2ObjectsObjectRecordsRecordIdResponse](../../models/operations/patchv2objectsobjectrecordsrecordidresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------------------- | -------------------------------------- | -------------------------------------- | | errors.MissingValueError | 400 | application/json | | errors.GetV2ObjectsObjectNotFoundError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## update Use this endpoint to update people, companies, and other records by `record_id`. If the update payload includes multiselect attributes, the values supplied will overwrite/remove the list of values that already exist (if any). Use the `PATCH` endpoint to append multiselect values without removing those that already exist. Required scopes: `record_permission:read-write`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.update({ object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsUpdate } from "attio-js/funcs/recordsUpdate.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsUpdate(attio, { object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", requestBody: { data: { values: { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": [ "Select option 1", "Select option 2", ], }, }, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutV2ObjectsObjectRecordsRecordIdRequest](../../models/operations/putv2objectsobjectrecordsrecordidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PutV2ObjectsObjectRecordsRecordIdResponse](../../models/operations/putv2objectsobjectrecordsrecordidresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------------------- | -------------------------------------- | -------------------------------------- | | errors.MissingValueError | 400 | application/json | | errors.GetV2ObjectsObjectNotFoundError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## delete Deletes a single record (e.g. a company or person) by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.delete({ object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsDelete } from "attio-js/funcs/recordsDelete.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsDelete(attio, { object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.DeleteV2ObjectsObjectRecordsRecordIdRequest](../../models/operations/deletev2objectsobjectrecordsrecordidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.DeleteV2ObjectsObjectRecordsRecordIdResponse](../../models/operations/deletev2objectsobjectrecordsrecordidresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | errors.GetV2ObjectsObjectRecordsRecordIdInvalidRequestError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## listAttributeValues Gets all values for a given attribute on a record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param. Required scopes: `record_permission:read`, `object_configuration:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.listAttributeValues({ object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", attribute: "41252299-f8c7-4b5e-99c9-4ff8321d2f96", limit: 10, offset: 5, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsListAttributeValues } from "attio-js/funcs/recordsListAttributeValues.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsListAttributeValues(attio, { object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", attribute: "41252299-f8c7-4b5e-99c9-4ff8321d2f96", limit: 10, offset: 5, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesRequest](../../models/operations/getv2objectsobjectrecordsrecordidattributesattributevaluesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse](../../models/operations/getv2objectsobjectrecordsrecordidattributesattributevaluesresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | errors.GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError | 400 | application/json | | errors.GetV2TargetIdentifierAttributesAttributeNotFoundError | 404 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## listEntries List all entries, across all lists, for which this record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. ### Example Usage ```typescript import { Attio } from "attio-js"; const attio = new Attio({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const result = await attio.records.listEntries({ object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", limit: 10, offset: 5, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { AttioCore } from "attio-js/core.js"; import { recordsListEntries } from "attio-js/funcs/recordsListEntries.js"; // Use `AttioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const attio = new AttioCore({ apiKey: process.env["ATTIO_API_KEY"] ?? "", }); async function run() { const res = await recordsListEntries(attio, { object: "people", recordId: "891dcbfc-9141-415d-9b2a-2238a6cc012d", limit: 10, offset: 5, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetV2ObjectsObjectRecordsRecordIdEntriesRequest](../../models/operations/getv2objectsobjectrecordsrecordidentriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetV2ObjectsObjectRecordsRecordIdEntriesResponse](../../models/operations/getv2objectsobjectrecordsrecordidentriesresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* |