GET /rest/v1.1/companies/{company_id}/users
Return a list of all active users associated with a company. To retrieve a list of inactive users, see List Company Inactive 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 |
Unique identifier for 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 |
filtersvendor_id[] |
Array | No |
Return item(s) with the specified Vendor IDs. |
filterscreated_at |
String | No |
Return item(s) created within the specified ISO 8601 datetime range.
Formats:
|
per_page |
Integer | No |
Elements per page |
sort |
String | No |
Return items with the specified sort. Possible values:
|
filtersupdated_at |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
filterssearch |
String | No |
Return users where the search string matches the user's first name, last name, email address, keywords, job title, or company name |
filtersorigin_id |
String | No |
Origin ID. Returns item(s) with the specified Origin ID. |
filterstrade_id[] |
Array | No |
Returns users whose vendor record is associated with the specified trade id(s). |
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.