GET /rest/v1.0/companies/{company_id}/users/{user_id}/project_assignments
This endpoint returns the current and potential Project assignments for the specified User. This includes Project information, as well as the Permission Template and Roles assigned to a given user when they are assigned on a Project.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
Integer | Yes |
Unique identifier for the company. |
user_id |
Integer | Yes |
User ID |
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 |
|---|---|---|---|
filters[by_region] |
No |
Return item(s) with the specified project region ID(s). |
|
sort |
String | No |
Sort the results by the specified field. Possible values:
|
filters[by_stage] |
No |
Return item(s) with the specified project stage ID(s). |
|
filters[project_roles] |
Integer | No |
Return item(s) with the Project Role ID(s). |
filters[name][] |
Array | No |
Filter item(s) with matching name. |
filters[active] |
Boolean | No |
If true, returns item(s) with a status of 'active'. |
page |
Integer | No |
Page |
filters[assignment_status] |
String | No |
Filters projects to those matching the given assignment status. Possible values:
|
direction |
String | No |
Sort direction. Default is ascending, nulls first. Possible values:
|
filters[project_permission_templates] |
Integer | No |
Return item(s) with the Project Permissions Template ID(s). |
per_page |
Integer | No |
Elements per page |
filters[by_program] |
No |
Return item(s) with the specified project program ID(s). |
|
filters[by_type] |
No |
Return item(s) with the specified project type ID(s). |
|
filters[by_status] |
String | No |
Return item(s) with the specified status value. Must be one of Active, Inactive, or All. Possible values:
|
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.