Skip to main content
GuidesAPI Reference

List Accounts

GET 
/crm/accounts

List accounts for a specified user and credential set

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber string

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    accountOwner string

    Filter accounts by the exact name of the account owner.

    accountOwnerContains string

    Filter accounts where the account owner's name contains the specified string.

    accountOwnerNotEquals string

    Filter accounts where the account owner's name is not the specified string.

    accountName string

    Filter accounts by the exact name of the account.

    accountNameContains string

    Filter accounts where the account name contains the specified string.

    accountNameNotEquals string

    Filter accounts where the account name is not the specified string.

    description string

    Filter accounts by the exact description text.

    descriptionContains string

    Filter accounts where the description contains the specified string.

    descriptionNotEquals string

    Filter accounts where the description is not the specified string.

    industry string

    Filter accounts by the exact industry name.

    industryContains string

    Filter accounts where the industry name contains the specified string.

    industryNotEquals string

    Filter accounts where the industry name is not the specified string.

    website string

    Filter accounts by the exact website URL.

    websiteContains string

    Filter accounts where the website URL contains the specified string.

    websiteNotEquals string

    Filter accounts where the website URL is not the specified string.

    numberOfEmployees int32

    Filter accounts by the exact number of employees.

    numberOfEmployeesMin int32

    Filter accounts with a minimum number of employees.

    numberOfEmployeesMax int32

    Filter accounts with a maximum number of employees.

    numberOfEmployeesNotEquals int32

    Filter accounts where the number of employees is not the specified number.

    lastActivityAt string

    Filter accounts based on the timestamp of the last activity. Typically, this would be a date string or timestamp.

    remoteCreatedAtMin date

    Filter objects created in the third-party application after a specified date.

    remoteCreatedAtMax date

    Filter objects created in the third-party application before a specified date.

    remoteUpdatedAtMin date

    Filter objects last updated in the third-party application after a specified date.

    remoteUpdatedAtMax date

    Filter objects last updated in the third-party application before a specified date.

    createdAtMin date

    Filter objects created after a specified date.

    createdAtMax date

    Filter objects created before a specified date.

    updatedAtMin date

    Filter objects last updated after a specified date.

    updatedAtMax date

    Filter objects last updated before a specified date.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    accounts

    object[]

  • Array [

    • website string
    industry string

    addresses

    object[]

  • Array [

    • country string
    street1 string
    state string
    city string
    addressType string
    postalCode string

  • ]

    • phoneNumbers

    object[]

  • Array [

    • phoneNumberType string
    phoneNumber string

  • ]

    • remoteId string
    lastActivityAt string
    accountOwner string
    accountName string
    numberOfEmployees integer

    Default value: 0

    description string
    id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string

  • ]

Loading...