Pipedrive API

Getting access, Developing, Testing

Back to Pipedrive

Get all persons

Returns all persons.

Input

type: object properties: parameters: type: object properties: user_id: type: integer description: >- If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. filter_id: type: integer description: The ID of the filter to use first_char: type: string description: >- If supplied, only persons whose name starts with the specified letter will be returned (case insensitive) start: type: integer default: 0 description: Pagination start limit: type: integer description: Items shown per page sort: type: string description: >- The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).

Output

title: getPersonsResponse200 type: object properties: success: type: boolean description: If the response is successful or not data: type: array description: The array of persons items: type: object title: personItem properties: id: type: integer description: The ID of the person company_id: type: integer description: The ID of the company related to the person active_flag: type: boolean description: Whether the person is active or not phone: type: array description: >- A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ "value": "12345", "primary": "true", "label": "mobile" }]`. Please note that only `value` is required. items: type: object properties: value: type: string description: The phone number primary: type: boolean description: >- Boolean that indicates if phone number is primary for the person or not label: type: string description: >- The label that indicates the type of the phone number. (Possible values - work, home, mobile or other) email: type: array description: >- An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ "value": "[email protected]", "primary": "true", "label": "main" } ]`. Please note that only `value` is required. items: type: object properties: value: type: string description: Email primary: type: boolean description: >- Boolean that indicates if email is primary for the person or not label: type: string description: >- The label that indicates the type of the email. (Possible values - work, home or other) first_char: type: string description: The first letter of the name of the person add_time: type: string description: >- The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS update_time: type: string description: >- The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS visible_to: type: string description: The visibility group ID of who can see the person picture_id: type: object properties: id: type: integer description: The ID of the picture associated with the item item_type: type: string description: The type of item the picture is related to item_id: type: integer description: The ID of related item active_flag: type: boolean description: Whether the associated picture is active or not add_time: type: string description: The add time of the picture update_time: type: string description: The update time of the picture added_by_user_id: type: integer description: The ID of the user who added the picture pictures: type: object properties: '128': type: string description: The URL of the 128*128 picture '512': type: string description: The URL of the 512*512 picture label: type: integer description: The label assigned to the person org_name: type: string description: The name of the organization associated with the person owner_name: type: string description: The name of the owner associated with the person cc_email: type: string description: The BCC email associated with the person owner_id: title: owner type: object properties: id: type: integer description: The ID of the user name: type: string description: The name of the user email: type: string description: The email of the user has_pic: type: integer description: >- Whether the user has picture or not. 0 = No picture, 1 = Has picture. pic_hash: type: string nullable: true description: The user picture hash active_flag: type: boolean description: Whether the user is active or not value: type: integer description: The ID of the owner org_id: title: relationshipOrganizationInfoItemWithActiveFlag type: object properties: name: type: string description: The name of the organization associated with the item people_count: type: integer description: >- The number of people connected with the organization that is associated with the item owner_id: type: integer description: >- The ID of the owner of the organization that is associated with the item address: type: string description: The address of the organization cc_email: type: string description: The BCC email of the organization associated with the item value: type: integer description: The ID of the organization active_flag: type: boolean description: Whether the associated organization is active or not name: type: string description: The name of the person first_name: type: string description: The first name of the person last_name: type: string description: The last name of the person email_messages_count: type: integer description: The count of email messages related to the person activities_count: type: integer description: The count of activities related to the person done_activities_count: type: integer description: The count of done activities related to the person undone_activities_count: type: integer description: The count of undone activities related to the person files_count: type: integer description: The count of files related to the person notes_count: type: integer description: The count of notes related to the person followers_count: type: integer description: The count of followers related to the person last_incoming_mail_time: type: string description: >- The date and time of the last incoming email associated with the person last_outgoing_mail_time: type: string description: >- The date and time of the last outgoing email associated with the person open_deals_count: type: integer description: The count of open deals related with the item related_open_deals_count: type: integer description: The count of related open deals related with the item closed_deals_count: type: integer description: The count of closed deals related with the item related_closed_deals_count: type: integer description: The count of related closed deals related with the item won_deals_count: type: integer description: The count of won deals related with the item related_won_deals_count: type: integer description: The count of related won deals related with the item lost_deals_count: type: integer description: The count of lost deals related with the item related_lost_deals_count: type: integer description: The count of related lost deals related with the item next_activity_date: type: string description: The date of the next activity associated with the deal next_activity_time: type: string description: The time of the next activity associated with the deal next_activity_id: type: integer nullable: true description: The ID of the next activity associated with the deal last_activity_id: type: integer nullable: true description: The ID of the last activity associated with the deal last_activity_date: type: string nullable: true description: The date of the last activity associated with the deal additional_data: type: object properties: pagination: description: Pagination details of the list type: object properties: start: type: integer description: Pagination start limit: type: integer description: Items shown per page more_items_in_collection: type: boolean description: Whether there are more list items in the collection than displayed next_start: type: integer description: Next pagination start related_objects: type: object properties: organization: type: object properties: ORGANIZATION_ID: type: object description: The ID of the organization associated with the item properties: id: type: integer description: The ID of the organization associated with the item name: type: string description: The name of the organization associated with the item people_count: type: integer description: >- The number of people connected with the organization that is associated with the item owner_id: type: integer description: >- The ID of the owner of the organization that is associated with the item address: type: string description: The address of the organization cc_email: type: string description: The BCC email of the organization associated with the item user: type: object properties: USER_ID: type: object title: userDataWithId description: The ID of the user properties: id: type: integer description: The ID of the user name: type: string description: The name of the user email: type: string description: The email of the user has_pic: type: integer description: >- Whether the user has picture or not. 0 = No picture, 1 = Has picture. pic_hash: type: string nullable: true description: The user picture hash active_flag: type: boolean description: Whether the user is active or not picture: type: object description: The picture that is associated with the item properties: PICTURE_ID: type: object description: The ID of the picture properties: id: type: integer description: The ID of the picture associated with the item item_type: type: string description: The type of item the picture is related to item_id: type: integer description: The ID of related item active_flag: type: boolean description: Whether the associated picture is active or not add_time: type: string description: The add time of the picture update_time: type: string description: The update time of the picture added_by_user_id: type: integer description: The ID of the user who added the picture pictures: type: object properties: '128': type: string description: The URL of the 128*128 picture '512': type: string description: The URL of the 512*512 picture