ROrossum
Membership

Retrieve membership

Changed on

Get a membership object.

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

Request

Path parameters

membershipIDinteger required

A unique integer value identifying this membership.

organizationGroupIDinteger required

A unique integer value identifying organization group.

Response

OK

idinteger required

ID of the membership

urlstring uri required

URL of the membership

userstring uri required

User URL.

organizationstring uri required

Organization URL.

queuesstring[] required

URLs of queues user has access to

expires_atstring date-time nullable required

Timestamp of membership expiration. Membership won't expire if no expiration is set.

Example response

{
  "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 body 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 body allOf list for the response status