--- title: "List a company's people" method: GET path: "/companies/{id}/people" tags: ["Companies"] --- # List a company's people `GET /companies/{id}/people` ## Request - Base URL: `https://api.pipelinecrm.com/api/v3` - URL: `https://api.pipelinecrm.com/api/v3/companies/{id}/people` - Auth: one of: - HTTP bearer - HTTP bearer and API key in header `app-key` - API key in query parameter `api_key` and API key in query parameter `app_key` ## Path parameters - `id` integer, required ## Query parameters - `page` integer - `per_page` integer ## Response `200` Successful Response - object - `entries` PersonAll[], required - `id` integer: Unique identifier - `user` object, nullable: A convenience object to get the name of the person [owner](#tag/users) - `id` integer - `first_name` string - `last_name` string - `owner` string: The owner's full name, or `N/A` when the record has no owner. - `created_by_user` object, nullable: The [user](#tag/users) who created the record - `id` integer - `first_name` string - `last_name` string - `company` object, nullable: A convenience object for the person's [company](#tag/companies) - `id` integer - `name` string - `deals` object[]: The [deals](#tag/deals) the person is associated with - `id` integer - `name` string - `currency` object: The currency `total_pipeline` and `won_deals_total` are expressed in (the caller's, falling back to the account's). - `id` integer - `name` string - `code` string - `symbol` string - `decimal_places` integer - `total_pipeline` union: The rounded value of the person's open deals, in `currency`. An integer, or a decimal string for large values. - integer - string - `won_deals_total` union: The rounded value of the person's won deals, in `currency`. An integer, or a decimal string for large values. - integer - string - `is_sample` boolean: Marks a record created by the sample-data generator. - `viewed_at` string, nullable: When the caller last opened the record in the app. - `project_shared_user_ids` integer[]: Users who see the record through a shared project. - `has_work_address` boolean - `has_home_address` boolean - `has_company_address` boolean: When `true`, the `company_address_1`, `company_address_2`, `company_city`, `company_state`, `company_postal_code` and `company_country` fields are present. - `work_address_google_maps_url` string, nullable - `home_address_google_maps_url` string, nullable - `company_address_google_maps_url` string, nullable - `company_address_1` string, nullable: Present when `has_company_address` is `true`. - `company_address_2` string, nullable: Present when `has_company_address` is `true`. - `company_city` string, nullable: Present when `has_company_address` is `true`. - `company_state` string, nullable: Present when `has_company_address` is `true`. - `company_postal_code` string, nullable: Present when `has_company_address` is `true`. - `company_country` string, nullable: Present when `has_company_address` is `true`. - `date_of_first_activity` string, nullable: Deal Intelligence. Present for accounts with the feature enabled. - `days_since_last_activity` integer, nullable: Deal Intelligence. Present for accounts with the feature enabled. - `hours_to_first_activity` string, nullable: Deal Intelligence, decimal hours serialized as a string. Present for accounts with the feature enabled. - `lead_status` object, nullable: A convenience object for this person record's [lead status](#tag/lead-statuses) - `id` integer - `name` string - `hex_color` string, nullable - `lead_source` object, nullable: A convenience object for this person record's [lead source](#tag/lead-sources) - `id` integer - `name` string - `image_mobile_url` string: A link to the person's mobile avatar. Mobile avatar is scaled to maximum of 100x100 pixels. - `predefined_contacts_tags` object[]: A convenience object for this person record's [tags](#tag/predefined-contacts-tags) - `id` integer - `name` string - `possible_notify_user_ids` integer[]: The list of [User](#tag/users) IDs that can be added to `notify_user_ids` on associated [notes](#tag/activities-notes). - `next_entry_name` string, nullable: Name of the next calendar entry due associated with the person - `next_entry_id` integer, nullable: The ID of the next calendar entry due associated with the person - `next_entry_due` string, nullable: Due date of the next calendar entry due associated with the person - `next_entry_all_day` boolean, nullable: Is the next calendar entry due associated with the person an all day event? - `created_at` string: Timestamp when the record was created (time zone in user's time zone). - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone). - `first_name` string, nullable: The person's first name. - `last_name` string, nullable: The person's last name. - `full_name` string: The person's full name. Will split on whitespace to set `first_name` and `last_name` fields - `summary` string, nullable: Summary or notes on the person. - `phone` string, nullable: Person's primary phone number - `home_phone` string, nullable: Person's home phone number - `mobile` string, nullable: Person's mobile phone number - `position` string, nullable: Person's professional position - `website` string, nullable: Person's website URL - `email` string, nullable: Person's primary email address - `email2` string, nullable: Person's secondary email address - `home_email` string, nullable: Person's non-professional email address - `company_id` integer, nullable: The ID of the [company](#tag/companies) associated to this person - `company_name` string, nullable: Associates the [company](#tag/companies) with this name to this person, creating it if none matches. - `user_id` integer: The ID of the [user](#tag/users) who owns this person record - `lead_status_id` integer: The ID of the [lead status](#tag/lead-statuses) to set for this person - `lead_source_id` integer: The ID of the [lead source](#tag/lead-sources) to set for this person - `image_thumb_url` string: A link to the person's avatar. Avatar is scaled to maximum of 50x50 pixels. - `predefined_contacts_tag_ids` integer[]: IDs of the [tags](#tag/predefined-contacts-tags) to set on this person - `work_address_1` string, nullable: First line of work address. - `work_address_2` string, nullable: Second line of work address. - `work_city` string, nullable: Work address city. - `work_state` string, nullable: Work address state. - `work_country` string, nullable: Work address country. - `work_postal_code` string, nullable: Work address postal code. - `home_address_1` string, nullable: First line of Home address. - `home_address_2` string, nullable: Second line of Home address. - `home_city` string, nullable: Home address city. - `home_state` string, nullable: Home address state. - `home_country` string, nullable: Home address country. - `home_postal_code` string, nullable: Home address postal code. - `facebook_url` string, nullable: URL to person's facebook profile - `linked_in_url` string, nullable: URL to person's LinkedIn profile - `twitter` string, nullable: Person's twitter username - `instant_message` string, nullable: Person's IM username - `unsubscribed` boolean: Whether or not the person has unsubscribed to newsletters - `bounced` boolean: Whether or not the person has had emails sent to them bounce - `last_emailed_at` string, nullable: When the person was last emailed timestamp - `custom_fields` object: Custom fields for the person. See [custom fields](#tag/custom-fields) section for more info. - `shared_user_ids` integer[]: The array of [User](#tag/users) IDs with whom this person's been shared (also known as Collaborators) - `relationship` string: The relationship of the person to the [company](#tag/companies) (e.g. "Father", "CEO", "Owner", etc.) - `is_key_contact` boolean: Whether or not this person is a key contact for the [company](#tag/companies) - `type` 'Contact' | 'Lead': Whether the record is a contact or a lead. Setting it on update converts the record. - `deal_ids` integer[]: The [deals](#tag/deals) the person is associated with. Set to the full list; deals left out are disassociated. - `fax` string, nullable - `created_by_user_id` integer, nullable: The [user](#tag/users) recorded as the creator. Defaults to the authenticated user. - `pagination` Pagination, required: Paging details returned alongside `entries` on every paginated list. - `page` integer: The page returned. Request another with `?page=N`. - `per_page` integer: Page size. `?per_page=N`, capped at 200. - `total` integer: Total number of records matching the request across all pages. - `pages` integer: Number of pages at this `per_page`. - `total_in_account` integer, nullable: Total number of records of this type visible to you before filters were applied. Null when not computed for the endpoint. - `page_var` string: Name of the query parameter that selects the page. Always `page`. - `url` string, nullable: Path of the request, when the endpoint reports it. ## Other responses - `404`: No record with that id is visible to this user. Records owned by other users that you cannot see also answer 404. --- [API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)