GET /rest/v1.0/companies/{company_id}/people/inactive
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 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[vendor_id][] |
Array | No |
Return item(s) with the specified Vendor IDs. |
view |
String | No |
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. Valid values:
|
filters[reference_users_only] |
Boolean | No |
If true, returns only people who are reference users. |
filters[without_reference_users] |
Boolean | No |
If true, returns only people who are not 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.