List Company Inactive Users
list_company_inactive_usersList inactive users for a company to discover them or retrieve their IDs before other operations. Supports pagination and filtering; read-only.
Instructions
Return a list of all Inactive Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Use this to discover company inactive users 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 company inactive users; 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}/users/inactive
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| sort | No | Query string parameter — return items with the specified sort. | |
| 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 company. |