Get user-profile contributor relationships

GET 
/user_profiles

Get user-profile contributor relationships

Request

Query Parameters

query object

Allows for pagination and sorting.

user_id uuid

The ID of a user for filtering

ne_attribute_id uuid

ID of an attribute for filtering

profile_id uuid

Profile ID to filter by

relationship_type string

Possible values: [owner, contributor]

Type of user contributor relationship to filter by

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

user_profiles object[]
Array [
id uuid
uid string
Possible values: >= 32 characters and <= 32 characters
user_id uuid
profile_id uuid
ne_attribute_id uuid
relationship_type string
Possible values: [owner, contributor]
]
_metadata object
limit integer
offset integer
total integer
next string
previous string

Example (from schema)

{
  "user_profiles": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "uid": "string",
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ne_attribute_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "relationship_type": "owner"
    }
  ],
  "_metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...