show

Membership Management (Project). Check out the product docs to learn more about Membership.

Retrieve project memberships

GET
/projects/{project_id}/memberships

Returns all memberships in a project.

  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

    project_id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve a membership

GET
/memberships/{id}

Returns a single membership.

  • Parameters
  • id
    string  (required) in path

    Membership UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the membership

PUT
/memberships/{id}

Updates the membership.

  • Parameters
  • id
    string  (required) in path

    Membership UUID

    membership
     (required) in body

    Membership to update

    {
        "role": [
            "string"
        ]
    }

Delete the membership

DELETE
/memberships/{id}

Deletes the membership.

  • Parameters
  • id
    string  (required) in path

    Membership UUID