Members

View organization members and their roles

Endpoints

GET/v1/members/me
GET/v1/members/{member_id}
GET/v1/organizations/{organization_id}/members
GET/v1/projects/{project_id}/members

Get current member

GET/v1/members/me

Returns the currently authenticated member.

Responses

200A member

object

memberobject
object
member model
- idinteger
- emailstring
- namestring
- screen_namestring
- time_zonestring
- created_atstring
- updated_atstring

Example response

json

{
  "member": {
    "id": 0,
    "email": "user@example.com",
    "name": "string",
    "screen_name": "string",
    "time_zone": "string",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

Get member

GET/v1/members/{member_id}

Returns the member with the given ID.

Parameters

Name	In	Type	Description
member_idrequired	path	integer (int32)	A member ID

Responses

200A member

object

memberobject
object
member model
- idinteger
- emailstring
- namestring
- screen_namestring
- time_zonestring
- created_atstring
- updated_atstring

Example response

json

{
  "member": {
    "id": 0,
    "email": "user@example.com",
    "name": "string",
    "screen_name": "string",
    "time_zone": "string",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

List organization members

GET/v1/organizations/{organization_id}/members

Returns a collection of members for the given organization.

Parameters

Name	In	Type	Description
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
organization_idrequired	path	integer (int32)	An organization ID

Responses

200A list of members

object

membersarray
array<object>
items
object
member model
- idinteger
- emailstring
- namestring
- screen_namestring
- time_zonestring
- created_atstring
- updated_atstring

Example response

json

{
  "members": [
    {
      "id": 0,
      "email": "user@example.com",
      "name": "string",
      "screen_name": "string",
      "time_zone": "string",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

List project members

GET/v1/projects/{project_id}/members

Returns a collection of members for the given project.

Parameters

Name	In	Type	Description
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
project_idrequired	path	integer (int32)	A project ID

Responses

200A list of members

object

membersarray
array<object>
items
object
member model
- idinteger
- emailstring
- namestring
- screen_namestring
- time_zonestring
- created_atstring
- updated_atstring

Example response

json

{
  "members": [
    {
      "id": 0,
      "email": "user@example.com",
      "name": "string",
      "screen_name": "string",
      "time_zone": "string",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}