JavaScript
import Moonbase from '@moonbaseai/sdk';
const client = new Moonbase({
apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});
const collection = await client.collections.retrieve('id');
console.log(collection.id);require "moonbase"
moonbase = Moonbase::Client.new(api_key: "My API Key")
collection = moonbase.collections.retrieve("id")
puts(collection)import os
from moonbase import Moonbase
client = Moonbase(
api_key=os.environ.get("MOONBASE_API_KEY"), # This is the default and can be omitted
)
collection = client.collections.retrieve(
"id",
)
print(collection.id)package main
import (
"context"
"fmt"
"github.com/moonbaseai/moonbase-sdk-go"
"github.com/moonbaseai/moonbase-sdk-go/option"
)
func main() {
client := moonbase.NewClient(
option.WithAPIKey("My API Key"),
)
collection, err := client.Collections.Get(context.TODO(), "id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", collection.ID)
}
curl --request GET \
--url https://api.moonbase.ai/v0/collections/{id} \
--header 'Authorization: Bearer <token>'{
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"name": "People",
"icon_name": "users",
"ref": "people",
"kind": "system",
"fields": [
{
"id": "1CLJt2uvQDDDdcM5HLetAm",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
}
],
"source_field": {
"id": "1CLJt2uuuSoypBNMtkVhwD",
"type": "field",
"collection": {
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
},
"ref": "assignee"
},
"name": "Assigned Tasks",
"ref": "assigned_tasks",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2v9J7dQtomdQemUF7",
"type": "field/choice",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"options": [
{
"id": "1CLJt2v8Yy2ZAfJZKmXhtn",
"type": "choice_field_option",
"name": "CEO Approval",
"color": "purple"
},
{
"id": "1CLJt2v8oMEB5Nnv24cJ1Z",
"type": "choice_field_option",
"name": "CTO Approval",
"color": "purple"
},
{
"id": "1CLJt2v93jRnz6HGiMgt8L",
"type": "choice_field_option",
"name": "Legal",
"color": "purple"
}
],
"name": "Buyer Criteria",
"ref": "buyer_criteria",
"description": "A field representing the internal approvals required before proceeding. Each selected value corresponds to a specific approval category. Possible values include:\n\"CEO Approval\" – Approval from the Chief Executive Officer\n\"CTO Approval\" – Approval from the Chief Technology Officer\n\"Legal\" – Approval or review by the Legal department\n",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2utuv1WBKQw7aBMU7",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
}
],
"source_field": {
"id": "1CLJt2utR9cGMtSDiz2BEZ",
"type": "field",
"collection": {
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
},
"ref": "contacts"
},
"name": "Contact on Deals",
"ref": "contact_on_deals",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2uc3tPQNgAfsYoMXM",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Created At",
"ref": "created_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2vBHBENAXgUy1QBBK",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
}
],
"reverse_field_name": "People",
"reverse_fields": [
{
"id": "1CLJt2vBXZRz5FAqfJUmJ6",
"type": "field",
"collection": {
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
},
"ref": "people"
}
],
"name": "Decision Maker",
"ref": "decision_maker",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2uizbzjphrfKo1po5",
"type": "field/text/multi_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Description",
"ref": "description",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2ugWmzYjYy6NrDwdK",
"type": "field/email",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Email",
"ref": "email",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2v5pkpkAnvdgXfEcF",
"type": "field/number/monetary",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"default_unit": "USD",
"name": "Estimate",
"ref": "estimate",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2ujz8oDTZp66yLBGB",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Call At",
"ref": "first_call_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ujjkbbYrKjQgFb9Q",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Interaction At",
"ref": "first_interaction_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ujVNPye8qNiPB12d",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Meeting At",
"ref": "first_meeting_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ujEzCMjRM2266Qur",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Message At",
"ref": "first_message_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2uhkgzeH8QsrKctDC",
"type": "field/text/single_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Job Title",
"ref": "job_title",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2ukyfbh6RmWt9eXjH",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Call At",
"ref": "last_call_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ukjHQ5BiHABrZwcW",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Interaction At",
"ref": "last_interaction_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ukUuCTGznoVZVMVj",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Meeting At",
"ref": "last_meeting_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ukEWzqNHJSoGQmNx",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Message At",
"ref": "last_message_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ui15CGBquEYchUKy",
"type": "field/uri/social_linked_in",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "LinkedIn Profile",
"ref": "linked_in_profile",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2uikDo7uzNJdVwEgJ",
"type": "field/geo",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Location",
"ref": "location",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2uboWBnTxgKBFimQa",
"type": "field/text/single_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Name",
"ref": "name",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2ugmACAeGTT59JXk6",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2uco2zG6pdjxS37sg",
"type": "collection",
"ref": "organizations"
}
],
"reverse_field_name": "People",
"reverse_fields": [
{
"id": "1CLJt2uhFvbQThSATjThye",
"type": "field",
"collection": {
"id": "1CLJt2uco2zG6pdjxS37sg",
"type": "collection",
"ref": "organizations"
},
"ref": "people"
}
],
"name": "Organization",
"ref": "organization",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2urvrQYubW5ZDYeXu",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
}
],
"source_field": {
"id": "1CLJt2urBhohBT31ULJtBa",
"type": "field",
"collection": {
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
},
"ref": "owner"
},
"name": "Owned Deals",
"ref": "owned_deals",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2vBXZRz5FAqfJUmJ6",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
}
],
"source_field": {
"id": "1CLJt2vBHBENAXgUy1QBBK",
"type": "field",
"collection": {
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
},
"ref": "decision_maker"
},
"name": "People",
"ref": "people",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2uiVqbW1GswwCreZX",
"type": "field/telephone_number",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Phone",
"ref": "phone",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2uwtWQw5uHDT78QsR",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
}
],
"source_field": {
"id": "1CLJt2uvtycTT3Knfvp4QK",
"type": "field",
"collection": {
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
},
"ref": "related_items"
},
"name": "Related Tasks",
"ref": "related_tasks",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2v6pHdDoet4Thyb5M",
"type": "field/stage",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"funnel": {
"id": "1CLJt2v74fpqiNNRA14BC8",
"type": "funnel",
"name": "Funnel",
"steps": [
{
"id": "1CLJt2v7K42Td5rmrJ8mJu",
"type": "funnel_step",
"step_type": "active",
"name": "Step 1",
"color": "red"
},
{
"id": "1CLJt2v7ZSE5XoM8YbDMRg",
"type": "funnel_step",
"step_type": "active",
"name": "Step 2",
"color": "red"
},
{
"id": "1CLJt2v7opRhSWqVEtHwYT",
"type": "funnel_step",
"step_type": "active",
"name": "Step 3",
"color": "red"
},
{
"id": "1CLJt2v84CdKMEKqwBNXfE",
"type": "funnel_step",
"step_type": "success",
"name": "Step 4",
"color": "red"
},
{
"id": "1CLJt2v8JapwFwpCdUT7n1",
"type": "funnel_step",
"step_type": "failure",
"name": "Step 5",
"color": "red"
}
],
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z"
},
"name": "Stage",
"ref": "stage",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2v5aNd8G5SGzEaeVU",
"type": "field/text/single_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Text_(Single Line)",
"ref": "text_single_line_22",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2ucJGb2HPf2Zqswe8",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Updated At",
"ref": "updated_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2uiFTPt6ZPbEun4Sk",
"type": "field/uri/social_x",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "X Profile",
"ref": "x_profile",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
}
],
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z"
}Collections
Retrieve a Collection
Retrieves the details of an existing collection.
GET
/
collections
/
{id}
JavaScript
import Moonbase from '@moonbaseai/sdk';
const client = new Moonbase({
apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});
const collection = await client.collections.retrieve('id');
console.log(collection.id);require "moonbase"
moonbase = Moonbase::Client.new(api_key: "My API Key")
collection = moonbase.collections.retrieve("id")
puts(collection)import os
from moonbase import Moonbase
client = Moonbase(
api_key=os.environ.get("MOONBASE_API_KEY"), # This is the default and can be omitted
)
collection = client.collections.retrieve(
"id",
)
print(collection.id)package main
import (
"context"
"fmt"
"github.com/moonbaseai/moonbase-sdk-go"
"github.com/moonbaseai/moonbase-sdk-go/option"
)
func main() {
client := moonbase.NewClient(
option.WithAPIKey("My API Key"),
)
collection, err := client.Collections.Get(context.TODO(), "id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", collection.ID)
}
curl --request GET \
--url https://api.moonbase.ai/v0/collections/{id} \
--header 'Authorization: Bearer <token>'{
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"name": "People",
"icon_name": "users",
"ref": "people",
"kind": "system",
"fields": [
{
"id": "1CLJt2uvQDDDdcM5HLetAm",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
}
],
"source_field": {
"id": "1CLJt2uuuSoypBNMtkVhwD",
"type": "field",
"collection": {
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
},
"ref": "assignee"
},
"name": "Assigned Tasks",
"ref": "assigned_tasks",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2v9J7dQtomdQemUF7",
"type": "field/choice",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"options": [
{
"id": "1CLJt2v8Yy2ZAfJZKmXhtn",
"type": "choice_field_option",
"name": "CEO Approval",
"color": "purple"
},
{
"id": "1CLJt2v8oMEB5Nnv24cJ1Z",
"type": "choice_field_option",
"name": "CTO Approval",
"color": "purple"
},
{
"id": "1CLJt2v93jRnz6HGiMgt8L",
"type": "choice_field_option",
"name": "Legal",
"color": "purple"
}
],
"name": "Buyer Criteria",
"ref": "buyer_criteria",
"description": "A field representing the internal approvals required before proceeding. Each selected value corresponds to a specific approval category. Possible values include:\n\"CEO Approval\" – Approval from the Chief Executive Officer\n\"CTO Approval\" – Approval from the Chief Technology Officer\n\"Legal\" – Approval or review by the Legal department\n",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2utuv1WBKQw7aBMU7",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
}
],
"source_field": {
"id": "1CLJt2utR9cGMtSDiz2BEZ",
"type": "field",
"collection": {
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
},
"ref": "contacts"
},
"name": "Contact on Deals",
"ref": "contact_on_deals",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2uc3tPQNgAfsYoMXM",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Created At",
"ref": "created_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2vBHBENAXgUy1QBBK",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
}
],
"reverse_field_name": "People",
"reverse_fields": [
{
"id": "1CLJt2vBXZRz5FAqfJUmJ6",
"type": "field",
"collection": {
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
},
"ref": "people"
}
],
"name": "Decision Maker",
"ref": "decision_maker",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2uizbzjphrfKo1po5",
"type": "field/text/multi_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Description",
"ref": "description",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2ugWmzYjYy6NrDwdK",
"type": "field/email",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Email",
"ref": "email",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2v5pkpkAnvdgXfEcF",
"type": "field/number/monetary",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"default_unit": "USD",
"name": "Estimate",
"ref": "estimate",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2ujz8oDTZp66yLBGB",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Call At",
"ref": "first_call_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ujjkbbYrKjQgFb9Q",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Interaction At",
"ref": "first_interaction_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ujVNPye8qNiPB12d",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Meeting At",
"ref": "first_meeting_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ujEzCMjRM2266Qur",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "First Message At",
"ref": "first_message_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2uhkgzeH8QsrKctDC",
"type": "field/text/single_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Job Title",
"ref": "job_title",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2ukyfbh6RmWt9eXjH",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Call At",
"ref": "last_call_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ukjHQ5BiHABrZwcW",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Interaction At",
"ref": "last_interaction_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ukUuCTGznoVZVMVj",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Meeting At",
"ref": "last_meeting_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ukEWzqNHJSoGQmNx",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Last Message At",
"ref": "last_message_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2ui15CGBquEYchUKy",
"type": "field/uri/social_linked_in",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "LinkedIn Profile",
"ref": "linked_in_profile",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2uikDo7uzNJdVwEgJ",
"type": "field/geo",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Location",
"ref": "location",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2uboWBnTxgKBFimQa",
"type": "field/text/single_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Name",
"ref": "name",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2ugmACAeGTT59JXk6",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2uco2zG6pdjxS37sg",
"type": "collection",
"ref": "organizations"
}
],
"reverse_field_name": "People",
"reverse_fields": [
{
"id": "1CLJt2uhFvbQThSATjThye",
"type": "field",
"collection": {
"id": "1CLJt2uco2zG6pdjxS37sg",
"type": "collection",
"ref": "organizations"
},
"ref": "people"
}
],
"name": "Organization",
"ref": "organization",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2urvrQYubW5ZDYeXu",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
}
],
"source_field": {
"id": "1CLJt2urBhohBT31ULJtBa",
"type": "field",
"collection": {
"id": "1CLJt2ue2wzMeQ5XRuS4TZ",
"type": "collection",
"ref": "deals"
},
"ref": "owner"
},
"name": "Owned Deals",
"ref": "owned_deals",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2vBXZRz5FAqfJUmJ6",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
}
],
"source_field": {
"id": "1CLJt2vBHBENAXgUy1QBBK",
"type": "field",
"collection": {
"id": "1CLJt2ubZ7zAZFBxUxeBHo",
"type": "collection",
"ref": "people"
},
"ref": "decision_maker"
},
"name": "People",
"ref": "people",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2uiVqbW1GswwCreZX",
"type": "field/telephone_number",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Phone",
"ref": "phone",
"cardinality": "many",
"required": false,
"unique": true,
"readonly": false,
"kind": "system"
},
{
"id": "1CLJt2uwtWQw5uHDT78QsR",
"type": "field/relation",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"relation_type": "two_way",
"allowed_collections": [
{
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
}
],
"source_field": {
"id": "1CLJt2uvtycTT3Knfvp4QK",
"type": "field",
"collection": {
"id": "1CLJt2ufGrzTByXJuNq13S",
"type": "collection",
"ref": "tasks"
},
"ref": "related_items"
},
"name": "Related Tasks",
"ref": "related_tasks",
"cardinality": "many",
"required": false,
"unique": false,
"readonly": false,
"kind": "inverse"
},
{
"id": "1CLJt2v6pHdDoet4Thyb5M",
"type": "field/stage",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"funnel": {
"id": "1CLJt2v74fpqiNNRA14BC8",
"type": "funnel",
"name": "Funnel",
"steps": [
{
"id": "1CLJt2v7K42Td5rmrJ8mJu",
"type": "funnel_step",
"step_type": "active",
"name": "Step 1",
"color": "red"
},
{
"id": "1CLJt2v7ZSE5XoM8YbDMRg",
"type": "funnel_step",
"step_type": "active",
"name": "Step 2",
"color": "red"
},
{
"id": "1CLJt2v7opRhSWqVEtHwYT",
"type": "funnel_step",
"step_type": "active",
"name": "Step 3",
"color": "red"
},
{
"id": "1CLJt2v84CdKMEKqwBNXfE",
"type": "funnel_step",
"step_type": "success",
"name": "Step 4",
"color": "red"
},
{
"id": "1CLJt2v8JapwFwpCdUT7n1",
"type": "funnel_step",
"step_type": "failure",
"name": "Step 5",
"color": "red"
}
],
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z"
},
"name": "Stage",
"ref": "stage",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2v5aNd8G5SGzEaeVU",
"type": "field/text/single_line",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Text_(Single Line)",
"ref": "text_single_line_22",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "custom"
},
{
"id": "1CLJt2ucJGb2HPf2Zqswe8",
"type": "field/datetime",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "Updated At",
"ref": "updated_at",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": true,
"kind": "system"
},
{
"id": "1CLJt2uiFTPt6ZPbEun4Sk",
"type": "field/uri/social_x",
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z",
"default_values": [],
"name": "X Profile",
"ref": "x_profile",
"cardinality": "one",
"required": false,
"unique": false,
"readonly": false,
"kind": "system"
}
],
"created_at": "2025-02-17T16:00:00.000Z",
"updated_at": "2025-02-17T16:00:00.000Z"
}Authorizations
Your Moonbase API key.
Path Parameters
The ID or ref of the Collection to retrieve.
Response
Successful response.
A Collection is a container for structured data, similar to a database table or spreadsheet. It defines a schema using a set of Fields and holds the data as a list of Items.
String representing the object’s type. Always collection for this object.
Allowed value:
"collection"Unique identifier for the object.
The user-facing name of the collection (e.g., “Organizations”).
A unique, stable, machine-readable identifier for the collection. This reference is used in API requests and does not change even if the name is updated.
system collections are managed by Moonbase (e.g., People, Organizations), form collections back a Form, and custom collections are user-created.
Available options:
system, form, custom fields
(SingleLineTextField · object | MultiLineTextField · object | IdentifierField · object | IntegerField · object | FloatField · object | MonetaryField · object | PercentageField · object | BooleanField · object | EmailField · object | UrlField · object | DomainField · object | SocialXField · object | SocialLinkedInField · object | TelephoneNumberField · object | GeoField · object | DateField · object | DatetimeField · object | ChoiceField · object | StageField · object | RelationField · object)[]
required
A list of Field objects that define the schema for items in this collection.
A field definition, which varies by type
- SingleLineTextField
- MultiLineTextField
- IdentifierField
- IntegerField
- FloatField
- MonetaryField
- PercentageField
- BooleanField
- EmailField
- UrlField
- DomainField
- SocialXField
- SocialLinkedInField
- TelephoneNumberField
- GeoField
- DateField
- DatetimeField
- ChoiceField
- StageField
- RelationField
Show child attributes
Show child attributes
Time at which the object was created, as an ISO 8601 timestamp in UTC.
Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
An optional, longer-form description of the collection's purpose.
The collection's icon, as a Phosphor icon name in kebab-case (e.g. users, chart-bar). Only present when an icon is set.
A list of saved View objects for presenting the collection's data.
Note: Only present when requested using the include query parameter.
Show child attributes
Show child attributes
⌘I