GET /rest/v1.0/companies/{company_id}/people
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.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
Integer | Yes |
ID of the company |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Page |
filters[job_title] |
String | No |
Returns only people who have the specified job title. |
filters[trade_id][] |
Array | No |
Array of Trade IDs. Returns item(s) with the specified Trade IDs. |
filters[connected] |
Boolean | No |
If true, returns only people who are connected users. If false, returns only people who are not connected users. |
filters[is_employee] |
Boolean | No |
If true, returns item(s) where |
filters[state_code] |
String | No |
Returns only people who have the specified state code. |
per_page |
Integer | No |
Elements per page |
filters[search] |
String | No |
Returns item(s) matching the specified search query string. |
filters[vendor_id][] |
Array | No |
Return item(s) with the specified Vendor IDs. |
filters[include_company_people] |
Boolean | No |
If true, returns people in the Company not just the Project. This option only works if the user has permission to create people in the project directory or permission to read from the company directory. |
filters[without_reference_users] |
Boolean | No |
If true, returns only people who are not reference users. |
filters[reference_users_only] |
Boolean | No |
If true, returns only people who are reference users. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.