List Company Users
list_company_users_v1_3_2Read-onlyIdempotent
Retrieve a paginated list of users in a company directory. Filter by status, creation date, or search terms to find specific directory records.
Instructions
Return a list of all 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 (v1.3): Core > Directory. Endpoint: GET /rest/v1.3/users
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Query string 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) | |
| filters__active | No | Query string parameter — if true, returns item(s) with a status of 'active'. | |
| filters__created_at | No | Query string parameter — return item(s) created within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYYY-MM-... | |
| filters__updated_at | No | Query string parameter — return item(s) last updated within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYY... | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor IDs. | |
| filters__origin_id | No | Query string parameter — origin ID. Returns item(s) with the specified Origin ID. | |
| filters__trade_id__ | No | Query string parameter — returns users whose vendor record is associated with the specified trade id(s). | |
| filters__search | No | Query string parameter — return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name | |
| sort | No | Query string parameter — return items with the specified sort. |