Skip to main content

List accounts

GET 
/v2/accounts

Fetches multiple account records. The records can be filtered, paged, and sorted according to the respective parameters.

Request​

Query Parameters

    ids integer[]

    IDs of accounts to fetch. If a record can't be found, that record won't be returned and your request will be successful

    crm_id string[]

    Filters accounts by crm_id. Multiple crm ids can be applied

    Example: [0030H000050qeeM]
    tag string[]

    Filters accounts by the tags applied to the account. Multiple tags can be applied

    Example: [important, lucrative]
    tag_id integer[]

    Filters accounts by the tag id's applied to the account. Multiple tag id's can be applied

    created_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    domain string

    Domain of the accounts to fetch. Domains are unique and lowercase

    website string[]

    Filters accounts by website. Multiple websites can be applied. An additional value of "_is_null" can be passed to filter accounts that do not have a website.

    Example: [https://example.com, http://example.com, https://www.example.com, _is_null]
    archived boolean

    Filters accounts by archived_at status. Returns only accounts where archived_at is not null if this field is true. Returns only accounts where archived_at is null if this field is false. Do not pass this parameter to return both archived and unarchived accounts. This filter is not applied if any value other than "true" or "false" is passed.

    name string[]

    Names of accounts to fetch. Name matches are exact and case insensitive. Multiple names can be fetched. Partial match is supported and applied when the "_starts_with" value is passed: v2/accounts?name[_starts_with]=value

    Example: [SalesLoft]
    account_stage_id integer[]

    Filters accounts by account_stage_id. Multiple account_stage_ids can be applied. An additional value of "_is_null" can be passed to filter accounts that do not have account_stage_id

    Example: [432]
    account_tier_id integer[]

    Filters accounts by account_tier_id. Multiple account tier ids can be applied

    Example: [432]
    owner_id string[]

    Filters accounts by owner_id. Multiple owner_ids can be applied. An additional value of "_is_null" can be passed to filter accounts that are unowned

    Example: [432, _is_null]
    owner_is_active boolean

    Filters accounts by whether the owner is active or not.

    Example: true
    last_contacted[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    last_contacted[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    last_contacted[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    last_contacted[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    custom_fields object

    Filters by accounts matching all given custom fields. The custom field names are case-sensitive, but the provided values are case-insensitive. Example: v2/accounts?custom_fields[custom_field_name]=custom_field_value

    Example: {"custom_field":"custom_field_value"}
    industry string[]

    Filters accounts by industry by exact match. Supports partial matching

    Example: [Atlanta]
    country string[]

    Filters accounts by country by exact match. Supports partial matching

    Example: [US]
    state string[]

    Filters accounts by state by exact match. Supports partial matching

    Example: [Georgia]
    city string[]

    Filters accounts by city by exact match. Supports partial matching

    Example: [Atlanta]
    owner_crm_id string[]

    Filters accounts by owner_crm_id. Multiple owner_crm_ids can be applied. An additional value of "_is_null" can be passed to filter accounts that are unowned. A "_not_in" modifier can be used to exclude specific owner_crm_ids. Example: v2/accounts?owner_crm_id[_not_in]=id

    Example: [432, _is_null]
    locales string[]

    Filters accounts by locale. Multiple locales are allowed

    user_relationships object

    Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values. Example: v2/accounts?user_relationships[name]=value

    Example: {"user_relationships":"user_relationship_value"}
    sort_by string

    Key to sort on, must be one of: created_at, updated_at, last_contacted_at, account_stage, account_stage_name, account_tier, account_tier_name, name, counts_people. Defaults to updated_at

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    limit_paging_counts boolean

    Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses​

Success

Schema
    id integer

    ID of Account

    created_at date-time

    Datetime of when the Account was created

    updated_at date-time

    Datetime of when the Account was last updated

    archived_at date-time

    Datetime of when the Account was archived, if archived

    name string

    Account Full Name

    domain string

    Website domain, not a fully qualified URI

    conversational_name string

    Conversational name of the Account

    description string

    Description

    phone string

    Phone number without formatting

    website string

    Website

    linkedin_url string

    Full LinkedIn url

    twitter_handle string

    Twitter handle, with @

    street string

    Street name and number

    city string

    City

    state string

    State

    postal_code string

    Postal code

    country string

    Country

    locale string

    Time locale

    industry string

    Industry

    company_type string

    Type of the Account's company

    founded string

    Date or year of founding

    revenue_range string

    Estimated revenue range

    size string

    Estimated number of people in employment

    crm_id string

    CRM ID

    crm_url string

    CRM url

    crm_object_type string

    CRM object type

    owner_crm_id string

    Mapped owner field from the CRM

    last_contacted_at date-time

    Datetime this Account was last contacted

    last_contacted_type string

    The type of the last touch to this Account. Can be call, email, other

    do_not_contact boolean

    Whether this company has opted out of communications. Do not contact someone at this company when this is set to true

    custom_fields object

    Custom fields are defined by the user's team. Only fields with values are presented in the API.

    user_relationships object

    Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values

    tags string[]

    All tags applied to this Account

    counts object
    people integer

    Number of people in SalesLoft associated with this Account

    owner object

    User that is marked as the owner of this Account

    id integer
    _href string
    creator object

    User that created this Account

    id integer
    _href string
    last_contacted_by object

    User that last contacted this Account

    id integer
    _href string
    last_contacted_person object

    Person who was last contacted at this Account

    id integer
    _href string
    company_stage object

    Company Stage that this Account has set. This is referred to as Account Stage in other parts of the API. When sorting by account_stage, the company stage's order is used

    id integer
    _href string
    account_tier object

    Account Tier that this Account has set

    id integer
    _href string
Loading...