PipelinerCRM
    logoPowered by Apidog Europe

    Accounts.get

    GET/entities/Accounts/{id}

    Returns Account with given id

    Request

    Path Params
    id
    string <uuid>
    required

    ID of Account to retrieve

    Request samples

    Responses

    OK(200)
    Record Not Found(404)
    Server Error(500)
    HTTP Code: 200
    Content Type : JSONapplication/json

    Account data

    Data Schema
    success
    boolean 
    optional

    True when response succeeded, false on error.

    Example:
    true
    data
    object (Account) 
    optional
    is_delete_protected
    boolean 
    read-onlyrequired

    Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

    Example:
    false
    id
    string <uuid>
    read-onlyrequired

    Unique identifier of entity.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    is_deleted
    boolean 
    read-onlyoptional

    Specifies if the entity is considered deleted.

    Example:
    false
    modified
    string <date-time>
    read-onlyoptional

    Last modification time.

    Example:
    2019-01-01T00:00:00
    created
    string <date-time>
    optional

    Creation time.

    Example:
    2019-01-01T00:00:00
    account_type
    string <uri>
    required

    Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties.

    currency_exchange_rates_list
    string <uri>
    optional

    Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

    customer_type
    string <uri>
    optional

    Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

    industry
    string <uri>
    optional

    Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

    owner
    string <uri>
    required

    Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

    parent_account
    string <uri>
    optional

    Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

    parent_account_relation_type
    string <uri>
    optional

    Relation to ParentAccountRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ParentAccountRelationType' object for properties.

    picture
    string <uri>
    optional

    Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties.

    unit
    string <uri>
    required

    Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.

    account_class
    enum<integer> 
    optional

    Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD

    Allowed values:
    12345
    Example:
    1
    account_type_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    address
    string 
    optional

    Multi-line text input field.

    Example:
    string
    city
    string 
    optional

    Simple text input field.

    Example:
    string
    comments
    string 
    optional

    Multi-line text input field.

    Example:
    string
    country
    string 
    optional

    Generic field wrapping sqlalchemy column, configurable by constructor.
    Good for one-of fields / generated fields.

    Example:
    string
    currency_exchange_rates_list_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    customer_type_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    email1
    string 
    optional

    Email address.

    Example:
    string
    email2
    string 
    optional

    Email address.

    Example:
    string
    email3
    string 
    optional

    Email address.

    Example:
    string
    email4
    string 
    optional

    Email address.

    Example:
    string
    email5
    string 
    optional

    Email address.

    Example:
    string
    health_category
    string <uuid>
    optional

    Generic field wrapping sqlalchemy column, configurable by constructor.
    Good for one-of fields / generated fields.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    health_status
    integer <int32>
    optional

    Generic field wrapping sqlalchemy column, configurable by constructor.
    Good for one-of fields / generated fields.

    Example:
    1
    home_page
    string 
    optional

    URL - HTTP address.

    Example:
    string
    industry_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    is_archived
    boolean 
    optional

    Boolean value.

    Example:
    false
    name
    string 
    required

    Name of the entity and its default text representation.

    Example:
    string
    owner_id
    string <uuid>
    required

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    parent_account_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    parent_account_relation_type_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    phone1
    string 
    optional

    Phone number.

    Example:
    string
    phone2
    string 
    optional

    Phone number.

    Example:
    string
    phone3
    string 
    optional

    Phone number.

    Example:
    string
    phone4
    string 
    optional

    Phone number.

    Example:
    string
    phone5
    string 
    optional

    Phone number.

    Example:
    string
    picture_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    quick_parent_account_name
    string 
    optional

    Simple text input field.

    Example:
    string
    share_mode
    enum<integer> 
    optional

    Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

    Allowed values:
    0123
    Example:
    0
    state_province
    string 
    optional

    Simple text input field.

    Example:
    string
    unit_id
    string <uuid>
    optional

    Relation to single entity instance.

    Example:
    01234567-abcd-dcba-ffff-000000000000
    zip_code
    string 
    optional

    Simple text input field.

    Example:
    string
    revision
    integer <int32>
    optional

    Revision when entity was lastly changed.

    Example:
    1
    formatted_name
    string 
    required
    Example:
    string
    social_media
    string <uri>
    optional

    Relation to AccountSocialRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountSocialRelation' object for properties.

    sharing_units
    array[string <uri>]
    optional

    Relations to SalesUnits.

    sharing_clients
    array[string <uri>]
    optional

    Relations to Clients.

    documents
    array[string <uri>]
    optional

    Relations to CloudObjects.

    is_favorite
    boolean 
    required
    Example:
    false
    is_unsubscribed
    boolean 
    optional

    If account has any unsubscribed email.

    Example:
    false
    tags
    array[string <uri>]
    optional

    Relations to Tags.

    static_profiles
    array[string <uri>]
    optional

    Relations to Profiles.

    health
    object 
    optional
    modified_by_user
    string <date-time>
    optional
    Example:
    2019-01-01T00:00:00
    Example
    Not configured
    Last modified: 18 days ago