Project Member

Project member is the link object between Projects and People (Users or Collaborators).

• Attributes
• Searchable attributes
• Operations
  • GET /projects/:project_id/project_members

Attributes

project

Project the membership is for.

When requesting, can be expanded to the full project object by including the query parameter expand=project.

• Type: object

member

Person the membership is for.

When requesting, can be expanded to the full person object by including the query parameter expand=member.

• Type: object

Searchable attributes

Project members can be searched by their id, email, and display_name attributes. See the search documentation for instructions how to do this.

Operations

GET /projects/:project_id/project_members

List all project members for the project, with optional limit and offset parameters, as a metadata-results object.

Example request

curl -X GET \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  https://helixteamhub.cloud/api/projects/luotsi/project_members

Example response

{
  "metadata": {
    "more_results": false,
    "next_offset": 2,
    "count": 2
  },
  "results": [
    {
      "api_status": 200,
      "api_timestamp": "2016-04-01T15:33:04Z",
      "project": {
        "id": "luotsi",
        "uuid": "743be99c-d627-4733-8a4f-30472573a1fb"
      },
      "member": {
        "id": "markowy",
        "uuid": "1c47ff18-d6c5-422c-8eb9-8873897012f0",
        "type": "user"
      }
    },
    {
      "api_status": 200,
      "api_timestamp": "2016-04-01T15:33:04Z",
      "project": {
        "id": "luotsi",
        "uuid": "743be99c-d627-4733-8a4f-30472573a1fb"
      },
      "member": {
        "id": "lfitzpatrick",
        "uuid": "91cbaa07-3985-4858-98db-1ffe54cbba2c",
        "type": "collaborator"
      }
    }
  ]
}

Example request with member and project fields expanded

curl -X GET \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  https://helixteamhub.cloud/api/projects/tech/project_members?expand=member,project

Example response with member and project fields expanded

{
  "metadata": {
    "more_results": false,
    "next_offset": 1,
    "count": 1
  },
  "results": [
    {
      "api_status": 200,
      "api_timestamp": "2016-04-01T15:36:30Z",
      "project": {
        "api_status": 200,
        "api_timestamp": "2016-04-01T15:36:30Z",
        "id": "tech",
        "created_at": "2015-09-26T09:54:45Z",
        "updated_at": "2015-09-26T09:54:45Z",
        "uuid": "743be99c-d627-4733-8a4f-30472573a1fb",
        "short_name": "tech",
        "name": "Tech",
        "description": "",
        "color": "orange",
        "visibility": "members",
        "labels": [
          "bug",
          "feature",
          "improvement"
        ],
        "properties": {},
        "hook_events": [
          "repository"
        ]
      },
      "member": {
        "api_status": 200,
        "api_timestamp": "2016-04-01T15:36:30Z",
        "id": "cblanks",
        "created_at": "2015-09-26T09:52:33Z",
        "updated_at": "2015-09-26T09:57:05Z",
        "uuid": "1c47ff18-d6c5-422c-8eb9-8873897012f0",
        "type": "collaborator",
        "email": "cblanks@helixteamhub.com",
        "short_name": "cblanks",
        "first_name": "Claretha",
        "last_name": "Blanks",
        "display_name": "Claretha Blanks",
        "company_admin": false,
        "instance_admin": false,
        "description": "",
        "phone": "",
        "title": "",
        "avatar": {
          "large": "",
          "medium": "",
          "small": ""
        },
        "synchronized_fields": [],
        "locale": "en",
        "source": ""
      }
    }
  ]
}