Sign in
Partnerships

Get a Partnership for administration

Changed on

Delegated Aura access tokens require partnerships:read; missing scope returns 403 FORBIDDEN. Returns one established Partnership for an authenticated administrator.

The response includes the Partnership identity, its Party reference, current member user references, and current ListingSource grant references. Member and grant references are ordered by ID and each array is bounded to at most 100 entries. memberCount and listingSourceGrantCount are complete counts, including references beyond the bounded arrays.

Missing Partnerships return PARTNERSHIP_NOT_FOUND. All success and error responses use Cache-Control: no-store because member user identifiers are returned.

get/api/v1/admin/partnerships/{partnershipId}

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/partnerships/{partnershipId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

partnershipIdstring required

Stable Partnership ID.

Response

Partnership details returned successfully.

partnershipIdstring required

Stable Partnership identifier.

memberUserIdsstring[] required

Current member User IDs in deterministic ascending ID order. At most 100 references are returned.

listingSourceIdsstring[] required

Current ListingSource grant IDs in deterministic ascending ID order. At most 100 references are returned.

memberCountinteger required

Complete number of current Partnership members.

listingSourceGrantCountinteger required

Complete number of current ListingSource grants.

createdstring date-time required

When the Partnership was created.

updatedstring date-time required

When the Partnership was last updated.

Changes

  • 999eda3fdd63Revision changes
    • breaking

      the / response's property format changed from uuid to no format for status

    • breaking

      the / response's property format changed from uuid to no format for status

    • breaking

      the response's property format changed from uuid to no format for status

    • breaking

      the / response's property format changed from uuid to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      for the path request parameter partnershipId, the format was generalized from uuid to no format

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • efd083758b82Revision changes
    • info

      endpoint added