Get user-profile contributor relationships

Get user-profile contributor relationships

Query Parameters

• query object

  Allows for pagination and sorting using the deepObject notation.

  
  

  resource?query[limit]=50&query[offset]=0&query[order]=label

  
  

  Parameter	Description	Default
  limit	Limits the number of results returned	100
  offset	Returns the results starting at the value provided	0
  order	Allows you to determine the order in which the data is returned (not available on profile attributes)	id

  Example: query[limit]=100&query[offset]=50&query[order]=created_at
• user_id uuid

  The ID of a user for filtering

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• ne_attribute_id uuid

  ID of an attribute for filtering

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• profile_id uuid

  Profile ID to filter by

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• relationship_type string

  Possible values: [owner, contributor]

  Type of user contributor relationship to filter by

  Example: owner
• metadata boolean

  Returns batching metadata in the response

  Example: true

Responses

• 200
• 400
• 500

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• user_profiles object[]

  id uuid

  The id

  uid string

  Possible values: >= 32 characters and <= 32 characters

  the uid

  user_id uuid

  The user id

  profile_id uuid

  The profile_id

  ne_attribute_id uuid

  The ne_attribute_id

  relationship_type string

  Possible values: [owner, contributor]

  the relationship_type

• _metadata object

  limit int32

  The limit

  offset int32

  The offset

  total int32

  The total

  next string

  The link to the next page of data

  previous string

  The link to the previous page of data

{
  "user_profiles": [
    {
      "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "user_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "profile_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "ne_attribute_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "relationship_type": "owner"
    }
  ],
  "_metadata": {
    "limit": 50,
    "offset": 100,
    "total": 10000,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

Bad Request - unable to complete.

application/json

• Schema
• Example (from schema)

---

Schema

oneOf
• MOD1
• MOD2
---
error
error
errors

{
  "error": "Invalid JSON syntax. Please check your syntax and try again."
}

Internal Server Error - returned on unhandled exceptions.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

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

Loading...