Projects API: Get contributor

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/projects/get_contributor
Handler	OperatelyWeb.Api.Projects.GetContributor

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
id	id primitive (encoded as string)	Yes	No	-
include_project	boolean	No	No	-
include_permissions	boolean	No	No	-
include_access_level	boolean	No	Yes	-

Outputs#

Field	Type	Required	Nullable
contributor	project_contributor object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/projects/get_contributor?id=value&include_access_level=true&include_permissions=true&include_project=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "contributor": {
    "__typename": "value",
    "access_level": "<access_options_int>",
    "id": "value",
    "permissions": "<project_permissions>",
    "person": "<person>",
    "project": "<project>",
    "responsibility": "value",
    "role": "champion"
  }
}