ROrossum
Membership

List memberships

Changed on

Retrieve all membership objects.

get/api/v1/organization_groups/{organizationGroupID}/memberships

Request

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

userinteger

ID of a user to filter memberships by

organizationinteger[]

Organization ID(s) filter

ordering'id' | '-id'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 3,
      "url": "https://example.rossum.app/api/v1/organization_groups/1/memberships/3",
      "user": "https://example.rossum.app/api/v1/users/10775",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "queues": [
        "https://example.rossum.app/api/v1/organization_groups/1/queues/3",
        "https://example.rossum.app/api/v1/organization_groups/1/queues/4"
      ]
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status