List Inactive Company People
list_inactive_company_peopleGet inactive people for a Procore company. Filter by search, job title, vendor, or trade to identify inactive contacts and retrieve their IDs for further use.
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 discover inactive company people or to look up the id of one before calling a tool that needs it. company_id defaults to the value set by procore_set_config when omitted. Returns a JSON array of inactive company people; page and per_page control pagination and the response reports how many pages remain. Read-only — it changes nothing in Procore. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: company_id. Procore API: Core > Directory. Endpoint: GET /rest/v1.0/companies/{company_id}/people/inactive
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| 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. | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| company_id | Yes | URL path parameter — unique identifier for the Procore company | |
| 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__trade_id | No | Query string parameter — array of Trade IDs. Returns item(s) with the specified Trade IDs. | |
| 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__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__state_code | No | Query string parameter — returns only people who have the specified state code. | |
| filters__is_employee | No | Query string parameter — if true, returns item(s) where `is_employee` value is true. | |
| filters__reference_users_only | No | Query string parameter — if true, returns only people who are reference users. | |
| filters__without_reference_users | No | Query string parameter — if true, returns only people who are not reference users. |