Get memberships

get
/memberships

Return a list of the memberships.

email
string

account email

page
string

page index

limit
string

page size

OK

meta
Meta

Meta data object.

Example:
{"code":200,"type":"OK","message":"Everything worked as expected."}
code
number
required
Default:
200
Example:
200
type
string
required
>= 1 characters
message
string
required
>= 1 characters
errors
array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data
object
memberships
array[Membership]

Object describes membership information.

pagination
Pagination

Pagination data

parameter_string
string

Unauthorized

meta
Meta

Meta data object.

Example:
{"code":200,"type":"OK","message":"Everything worked as expected."}
code
number
required
Default:
200
Example:
200
type
string
required
>= 1 characters
message
string
required
>= 1 characters
errors
array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data
object

Internal Server Error

meta
Meta

Meta data object.

Example:
{"code":200,"type":"OK","message":"Everything worked as expected."}
code
number
required
Default:
200
Example:
200
type
string
required
>= 1 characters
message
string
required
>= 1 characters
errors
array[Error]

Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

data
object
Auth
:
Parameters
:
:
:
Response Example
{ "meta": { "code": 200, "type": "OK", "message": "Everything worked as expected." }, "data": { "memberships": [ { "id": "4a6091f28bf645a09246899722ce8a21", "organization": { "id": "511ceb52969b400a93e3422c743ae34a" }, "account": { "id": "74d998151a1b4668bee5a283712dd57e", "email": "[email protected]" }, "role": { "code": "admin", "name": "Admin" } } ], "pagination": { "page": 1, "limit": 100, "total": 1 }, "parameter_string": "" } }