Skip to main content

Get all board members

GET 
/v2/boards/:board_id/members

Retrieves a pageable list of members for a board.

Required scope

boards:read

Rate limiting

Level 1

Request​

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board to which the board member belongs.

Query Parameters

    limit string

    Possible values: >= 1 and <= 50

    offset string

Responses​

Board members retrieved

Schema

    data

    object[]

    Contains the result data.

  • Array [

    • id stringrequired

    Unique identifier (ID) of the user.

    name stringrequired

    Name of the user.

    role string

    Possible values: [viewer, commenter, editor, coowner, owner]

    Role of the board member.

    type stringrequired

    Type of the object that is returned. In this case, type returns board_member.

  • ]

    • total int64

    Total number of results available. If the value of the total parameter is higher than the value of the size parameter, this means that there are more results that you can retrieve. To retrieve more results, you can make another request and set the offset value accordingly. For example, if there are 30 results, and the request has the offset set to 0 and the limit set to 20, the size parameter will return 20 and the total parameter will return 30. This means that there are 9 more results to retrieve (as the offset is zero-based).

    size int32

    Number of results returned in the response. The size is the number of results returned considering the offset and the limit values sent in the request. For example, if there are 30 results, and the request has the offset set to 0 and the limit set to 20, the size of the results will be 20.
    If there are 10 results, and the request has the offset set to 0 and the limit set to 20, the size of the results will be 10.
    If there are 30 results, and the request has the offset set to 28 and the limit set to 20, the size of the results will be 2 as the offset is the zero-based offset of the first item in the collection.

    offset int32

    Zero-based index of the first item in the collection. For example, If there are 30 results, and the request has the offset set to 28, the response will return 2 results.

    limit int32

    Maximum number of results returned based on the limit specified in the request. For example, if there are 30 results, and the request has the offset set to 0 and the limit set to 20, the size of the results will be 20. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the offset parameter. In this example, you will set the offset parameter to 20 as the offset is zero-based.

    links

    object

    Contains pagination links for the collection.

    first string

    Link to retrieve information in the first page of the collection.

    last string

    Link to the retrieve information in the last page of the collection.

    next string

    Link to retrieve information in the next page of the collection.

    prev string

    Link to retrieve information in the previous page of the collection.

    self string

    Link to retrieve information in the current page of the collection.

    type string
Loading...