--- title: "List accounts" method: GET path: "/entities/Accounts" tags: ["Account"] --- # List accounts `GET /entities/Accounts` ## 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/Accounts` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the accounts the API application can read, one page at a time. In the list envelope, `total` counts every match; page forward with `after` set to `page_info.end_cursor` until `has_next_page` is false. ## 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 Account records. - object - `success` boolean: True when the request succeeded; false on error. - `data` Account[] - `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_type` string, uri, required: Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. Related AccountType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AccountType' for its fields. - `currency_exchange_rates_list` string, uri: Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. Related CurrencyExchangeRatesList record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CurrencyExchangeRatesList' for its fields. - `customer_type` string, uri: Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. Related Data record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Data' for its fields. - `industry` string, uri: Industry the account operates in. Configurable per team space. Related Data record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Data' for its fields. - `owner` string, uri, required: Sales user who owns this account. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `parent_account` string, uri: Parent account in a corporate hierarchy. Empty for top-level accounts. 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. - `parent_account_relation_type` string, uri: Type of relationship to the parent account (e.g. subsidiary, branch). Required when parent_account is set. Related ParentAccountRelationType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ParentAccountRelationType' for its fields. - `picture` string, uri: Profile picture or company logo associated with the account. 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. - `unit` string, uri, required: Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. Related SalesUnit record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'SalesUnit' for its fields. - `account_class` 1 | 2 | 3 | 4 | 5: Manual classification grade assigned to the account. Used in segmentation and reporting. Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD - `account_type_id` string, uuid: Id of the account type assigned to this account. - `address` string: Street address of the account. - `city` string: City of the account address. - `comments` string: Free-form notes describing the account. - `country` string: Country of the account address. - `currency_exchange_rates_list_id` string, uuid: Id of the currency exchange rate list applied to this account. - `customer_type_id` string, uuid: Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1` string: Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2` string: Additional email address. - `email3` string: Additional email address. - `email4` string: Additional email address. - `email5` string: Additional email address. - `health_category` string, uuid: Coarser bucket of health_status used for grouping and reporting. Read-only. - `health_status` integer: Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. - `home_page` string: Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industry_id` string, uuid: Id of the industry classification. - `is_archived` boolean: True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `last_ai_account_hierarchy_applied` string, date-time: Time when an AI-suggested account hierarchy was last applied to this account. - `last_ai_org_chart_applied` string, date-time: Time when an AI-suggested org chart was last applied to this account. - `name` string, required: Name of the entity and its default text representation. - `owner_id` string, uuid, required: Id of the account owner. - `parent_account_id` string, uuid: Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parent_account_relation_type_id` string, uuid: Id of the parent-account relationship type. - `phone1` string: Primary phone number of the account. Used as default target for click-to-call. - `phone2` string: Additional phone number. - `phone3` string: Additional phone number. - `phone4` string: Additional phone number. - `phone5` string: Additional phone number. - `picture_id` string, uuid: Id of the profile picture document. - `quick_parent_account_name` string: Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. - `share_mode` 0 | 1 | 2 | 3: Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit - `state_province` string: State or province of the account address. - `unit_id` string, uuid: Id of the sales unit. - `zip_code` string: ZIP or postal code of the account address. - `revision` integer: Revision when entity was lastly changed. - `formatted_name` string, required: Display version of the account name, used in lists and references. - `social_media` string, uri: Social network profiles linked to this account (e.g. LinkedIn, Facebook). Related AccountSocialRelation record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AccountSocialRelation' for its fields. - `sharing_units` string[]: Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing. - `sharing_clients` string[]: Users that have been granted shared access to this account. Editable only when share_mode allows user sharing. - `documents` string[]: Documents linked to this account. - `is_favorite` boolean, required: True when the current authenticated user has marked this account as favorite. Per-user. - `is_unsubscribed` boolean: If account has any unsubscribed email. - `tags` string[]: Tag labels applied to this account. - `static_profiles` string[]: Saved view profiles this account currently matches. - `health` object: Composite entity-health summary, combining current and previous state with last-calculation metadata. Read-only; computed by Coevera. - `modified_by_user` string, date-time: Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. - `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)