AFaffinda
Add x-hidden to endpoints

Get list of all organization memberships

Changed on

Returns all the organization memberships

get/v3/organization_memberships

Request

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger
Example:20

The numbers of results to return.

organizationstring

Uniquely identify an organization.

Example:mEFayXdO

Filter by organization.

role'admin' | 'member'
Example:admin

Filter by role.

Response

Memberships of the organizations you created or joined.

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "organization": "mEFayXdO",
      "user": {
        "id": 1,
        "name": "Carl Johnson",
        "username": "carljohnson",
        "email": "carljohnson@grove.street",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
      },
      "role": "admin"
    }
  ]
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Add x-hidden to endpoints added

    • info

      api tag Organization API - Membership removed

  • 9b7d1081f5bcRevision changes
    • breaking

      for the query request parameter limit, default value 300 was removed

    • breaking

      for the query request parameter limit, the max was decreased from 300.00 to 100.00