List Company Inactive Users
list_company_inactive_usersRetrieve a paginated list of inactive users for a company. Use filtering to locate specific directory records.
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 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}/users/inactive
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| 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) | |
| sort | No | Query string parameter — return items with the specified sort. |