# Retrieve memberships

Retrieves a list of organization memberships.

Endpoint: GET /memberships
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

## Response 200 fields (application/json):

  - `organization` (object, required)
    Organization membership.

  - `organization.id` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `organization.name` (string)
    Name of the organization.

  - `organization.createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `organization.updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `user` (object, required)
    Membership user.

  - `user.id` (string)
    ID of the user.
    Example: "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"

  - `user.name` (string)
    First and last name of the user.

  - `user.email` (string)
    Email address of the user.

  - `allowedIps` (array,null)
    List of IP addresses that are permitted access.
Private subnets are prohibited.
To remove restrictions, set this value to .
    Example: ["153.12.32.33","201.54.122.0/24","2001:0db8:abcd:0012:0000:0000:0000:ffff","2001:db8:abcd:12::0/64"]

  - `permissions` (array)
    Example: ["PostFile","StorefrontGetAccount","StorefrontGetWebsite","StorefrontGetKycDocumentCollection","StorefrontGetKycDocument","StorefrontPostKycDocument"]

  - `isOwner` (boolean)
    Specifies if the user is the owner of the organization.

  - `isDefault` (boolean)
    Specifies if the organization is the default organization for the user.

  - `roleIds` (array)
    Role IDs associated with the user.
Role IDs specify the roles that the user performs within the organization.
For example, the user may be an organization admin.

  - `acl` (array)
    Access Control List (ACL) information.

  - `acl.scope` (object, required)
    Example: {"organizationId":["organizationId-id-1"]}

  - `acl.scope.organizationId` (array)
    Array of account IDs.
    Example: ["organizationId-id-1"]

  - `acl.scope.productId` (array)
    Array of product IDs.
    Example: ["prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"]

  - `acl.scope.planId` (array)
    Array of plan IDs.
    Example: ["plan_0YV7DENSVGDBW9S71XZNNYYQ0X"]

  - `acl.scope.customFieldName` (array)
    Array of custom field names.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

  - `_embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `_embedded.roles` (array)

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.