Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

TeamMembersApi.md

Latest commit

 

History

History
195 lines (120 loc) · 5.12 KB

TeamMembersApi.md

File metadata and controls

195 lines (120 loc) · 5.12 KB

TeamMembersApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteMember DELETE /members/{memberId} Delete a team member by ID.
getMe GET /members/me Get the current team member associated with the token
getMember GET /members/{memberId} Get a single team member by ID.
getMembers GET /members Returns a list of all members in the account.
patchMember PATCH /members/{memberId} Modify a team member by ID.
postMembers POST /members Invite new members.

deleteMember

Delete a team member by ID.

Example

 deleteMember memberId=value

Parameters

Name Type Description Notes
memberId string The member ID.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMe

Get the current team member associated with the token

Example

 getMe

Parameters

This endpoint does not need any parameter.

Return type

Member

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMember

Get a single team member by ID.

Example

 getMember memberId=value

Parameters

Name Type Description Notes
memberId string The member ID.

Return type

Member

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMembers

Returns a list of all members in the account.

Example

 getMembers  limit=value  offset=value  filter=value  sort=value

Parameters

Name Type Description Notes
limit integer The number of objects to return. Defaults to -1, which returns everything. [optional]
offset integer Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. [optional]
filter string A comma-separated list of filters. Each filter is of the form field:value. [optional]
sort string A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. [optional]

Return type

Members

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchMember

Modify a team member by ID.

Example

 patchMember memberId=value

Parameters

Name Type Description Notes
memberId string The member ID.
patchDelta array[PatchOperation] Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

Return type

Member

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postMembers

Invite new members.

Example

 postMembers

Parameters

Name Type Description Notes
membersBody array[MembersBody] New members to invite.

Return type

Members

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]