--- title: "CloudObjectRelations.list" method: GET path: "/entities/CloudObjectRelations" tags: ["Document"] --- # CloudObjectRelations.list `GET /entities/CloudObjectRelations` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/CloudObjectRelations` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a page of CloudObjectRelation records, optionally filtered, sorted and limited to selected fields. ## Query parameters - `include-deleted` boolean - `first` integer - `last` integer - `before` string - `after` string - `expand` string - `order-by` string - `filter` object - `filter-op` object - `load-only` string ## Response `200` Page of CloudObjectRelation records. - object - `success` boolean: True when the request succeeded; false on error. - `data` CloudObjectRelation[] - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `account` string, uri: Account the file is attached to, or empty when not attached to an account. Related Account record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Account' for its fields. - `appointment` string, uri: Appointment the file is attached to. Set when activity_id resolves to an Appointment. Related Appointment record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Appointment' for its fields. - `task` string, uri: Task the file is attached to. Set when activity_id resolves to a Task. Related Task record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Task' for its fields. - `approval_process` string, uri: Approval process the file is attached to. Related ApprovalProcess record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ApprovalProcess' for its fields. - `call` string, uri: Call the file is attached to (e.g. a call recording). Related Call record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Call' for its fields. - `cloud_object_folder` string, uri: Folder the file is filed under within the parent record, or empty when stored at the record root. Related CloudObjectFolder record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CloudObjectFolder' for its fields. - `cloud_object` string, uri: Cloud object (file) being linked. Related CloudObject record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CloudObject' for its fields. - `contact` string, uri: Contact the file is attached to, or empty when not attached to a contact. Related Contact record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Contact' for its fields. - `custom_entity` string, uri: Custom entity record the file is attached to. Related CustomEntity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CustomEntity' for its fields. - `email_sequence` string, uri: Email sequence the file is attached to. Related EmailSequence record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EmailSequence' for its fields. - `email_template` string, uri: Email template the file is attached to as a template attachment. Related EmailTemplate record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'EmailTemplate' for its fields. - `field_mapping` string, uri: Field mapping the file is attached to (e.g. an import file). Related FieldMapping record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'FieldMapping' for its fields. - `lead` string, uri: Lead the file is attached to. Set when lead_oppty_id resolves to a Lead. Related Lead record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Lead' for its fields. - `oppty` string, uri: Opportunity the file is attached to. Set when lead_oppty_id resolves to an Opportunity. Related Opportunity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Opportunity' for its fields. - `media` string, uri: Media record the file is attached to. Related Media record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Media' for its fields. - `email` string, uri: Email the file is attached to (e.g. an email attachment). Set when message_id resolves to an Email. Related Email record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Email' for its fields. - `memo` string, uri: Memo the file is attached to. Set when message_id resolves to a Memo. Related Memo record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Memo' for its fields. - `online_form_field` string, uri: Online form field the file was uploaded into. Related Field record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Field' for its fields. - `online_form` string, uri: Online form submission the file was uploaded with. Related OnlineForm record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OnlineForm' for its fields. - `process` string, uri: Sales process the file is attached to. Related Process record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Process' for its fields. - `process_template` string, uri: Sales process template the file is attached to. Related ProcessTemplate record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProcessTemplate' for its fields. - `project` string, uri: Project the file is attached to. Related Project record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Project' for its fields. - `quote` string, uri: Quote the file is attached to. Related Quote record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Quote' for its fields. - `report_schedule` string, uri: Report schedule the file is attached to (e.g. an exported report). Related ReportSchedule record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ReportSchedule' for its fields. - `text_message` string, uri: Text message (SMS/MMS) the file is attached to. Related TextMessage record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TextMessage' for its fields. - `account_id` string, uuid: Id of the linked account. - `activity_id` string, uuid: Id of the linked appointment or task, or empty when not linked. - `approval_process_id` string, uuid: Id of the linked approval process. - `call_id` string, uuid: Id of the linked call. - `cloud_object_folder_id` string, uuid: Id of the folder within the parent record, or empty when stored at the record root. - `cloud_object_id` string, uuid: Id of the linked file. - `contact_id` string, uuid: Id of the linked contact. - `custom_entity_id` string, uuid: Id of the linked custom entity record. - `email_sequence_id` string, uuid: Id of the linked email sequence. - `email_template_id` string, uuid: Id of the linked email template. - `field_mapping_id` string, uuid: Id of the linked field mapping. - `lead_oppty_id` string, uuid: Id of the linked lead or opportunity, or empty when not linked. - `media_id` string, uuid: Id of the linked media record. - `message_id` string, uuid: Id of the linked email or memo, or empty when not linked. - `online_form_field_id` string, uuid: Id of the online form field the file was uploaded into. - `online_form_id` string, uuid: Id of the linked online form submission. - `process_id` string, uuid: Id of the linked sales process. - `process_template_id` string, uuid: Id of the linked sales process template. - `project_id` string, uuid: Id of the linked project. - `quote_id` string, uuid: Id of the linked quote. - `report_schedule_id` string, uuid: Id of the linked report schedule. - `text_message_id` string, uuid: Id of the linked text message. - `revision` integer: Revision when entity was lastly changed. - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used. - `start_cursor` string: Cursor of the first record of the page. - `end_cursor` string: Cursor of the last record of the page. - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them. - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them. - `total` integer: Number of records that match the request, across all pages. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)