List Company People
list_company_peopleRead-onlyIdempotent
Retrieve a paginated list of people in a Procore company directory. Filter by name, vendor, trade, or employee status to find specific directory records.
Instructions
Return a list of People associated with a Company. Includes users in the directory and reference users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Use this to enumerate Directory records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Directory records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id. Procore API: Core > Directory. Endpoint: GET /rest/v1.0/companies/{company_id}/people
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the Procore company | |
| view | No | Query string parameter — specifies which view of the resource to return (which attributes should be present in the response). If a valid view is not provided, it will default to normal. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__is_employee | No | Query string parameter — if true, returns item(s) where `is_employee` value is true. | |
| filters__without_reference_users | No | Query string parameter — if true, returns only people who are not reference users. | |
| filters__reference_users_only | No | Query string parameter — if true, returns only people who are reference users. | |
| filters__search | No | Query string parameter — returns People where the search string matches the Person's name (first, last, or full), email address, mobile phone, business phone, fax number, or job title. | |
| filters__connected | No | Query string parameter — if true, returns only people who are connected users. If false, returns only people who are not connected users. | |
| filters__state_code | No | Query string parameter — returns only people who have the specified state code. | |
| filters__job_title | No | Query string parameter — returns only people who have the specified job title. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor IDs. | |
| filters__trade_id | No | Query string parameter — array of Trade IDs. Returns item(s) with the specified Trade IDs. |