Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Attribute type

member

​
Use it for

Assigning records to workspace members.

​
Request value

Send a user ID string. For multi-member attributes, send an array of user ID strings. 
{
  "fields": {
    "owner": "user_id"
  }
}

​
Returned shape

Returns { "userId", "name", "email" }. Multi-member attributes return an array of those objects.

​
Example response

{
  "fields": {
    "owner": {
      "userId": "user_id",
      "name": "Ada Lovelace",
      "email": "ada@example.com"
    }
  }
}

​
Multiple values

For a multi-member attribute, send an array of user ID strings. 
{
  "fields": {
    "owners": [
      "user_ada",
      "user_grace"
    ]
  }
}
Returns an array of { "userId", "name", "email" } objects. 
{
  "fields": {
    "owners": [
      {
        "userId": "user_ada",
        "name": "Ada Lovelace",
        "email": "ada@example.com"
      },
      {
        "userId": "user_grace",
        "name": "Grace Hopper",
        "email": "grace@example.com"
      }
    ]
  }
}