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

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
filtersactive Boolean No

If true, returns item(s) with a status of 'active'.

filtersby_status String No

Return item(s) with the specified status value. Must be one of Active, Inactive, or All.

Possible values:

  • "Inactive"
  • "Active"
  • "All"
filtersby_stage No

Return item(s) with the specified project stage ID(s).

sort String No

Sort the results by the specified field.

Possible values:

  • "active"
  • "address"
  • "project_number"
  • "project_type"
  • "name"
  • "permission_template_name"
  • "stage"
  • "region"
  • "program"
filtersby_region No

Return item(s) with the specified project region ID(s).

filtersby_type No

Return item(s) with the specified project type ID(s).

filtersassignment_status String No

Filters projects to those matching the given assignment status.

Possible values:

  • "Assigned"
  • "Unassigned"
  • "All"
filtersproject_permission_templates Integer No

Return item(s) with the Project Permissions Template ID(s).

page Integer No

Page

filtersname[] Array No

Filter item(s) with matching name.

filtersproject_roles Integer No

Return item(s) with the Project Role ID(s).

direction String No

Sort direction. Default is ascending, nulls first.

Possible values:

  • "desc"
  • "asc"
per_page Integer No

Elements per page

filtersby_program No

Return item(s) with the specified project program ID(s).

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.