--- updatedAt: 2025-02-20T01:24:58.000Z agentTools: projectIndex: https://developers.livestorm.co/llms.txt --- # List people_attributes List the people_attributes of your workspace. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Livestorm - Public API", "description": "Welcome to Livestorm's Public API documentation.\nThe Livestorm API is organized around REST principles.\nIn addition, all request and response bodies, including errors, are encoded in JSON format.\n", "termsOfService": "https://livestorm.co/terms/", "contact": { "name": "Contact", "url": "https://support.livestorm.co", "email": "help@livestorm.co" }, "version": "1" }, "servers": [ { "url": "https://{defaultHost}", "variables": { "defaultHost": { "default": "api.livestorm.co/v1" } } } ], "components": { "securitySchemes": { "api_key": { "type": "apiKey", "name": "Authorization", "in": "header" }, "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "scopes": { "full:read": "Grants read access", "full:write": "Grants write access" } } } } }, "schemas": { "BaseResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "type": { "type": "string", "description": "Type" } } }, "Meta": { "type": "object", "properties": { "record_count": { "type": "integer", "description": "Total Record Count" }, "page_count": { "type": "integer", "description": "Page Count" }, "items_per_page": { "type": "integer", "description": "Items per page" } } } } }, "paths": { "/people_attributes": { "get": { "summary": "List people_attributes", "tags": [ "PeopleAttributes" ], "description": "List the people_attributes of your workspace.", "security": [ { "api_key": [] }, { "oauth2": [] } ], "parameters": [ { "name": "page[number]", "in": "query", "schema": { "type": "string" }, "description": "Page index to be returned", "required": false }, { "name": "page[size]", "in": "query", "schema": { "type": "string" }, "description": "Number of record to be returned by page", "required": false }, { "name": "sort", "in": "query", "description": "Sortable Fields: (-)slug, name, placeholder, created_at, updated_at", "required": false, "schema": { "type": "string" } }, { "name": "filter[builtin]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by builtin", "required": false }, { "name": "filter[description]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by description", "required": false }, { "name": "filter[name]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by name", "required": false }, { "name": "filter[placeholder]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by placeholder", "required": false }, { "name": "filter[slug]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by slug", "required": false }, { "name": "filter[type]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by type\n (text, email, avatar, url, consent, unique_select, multiple_select)", "required": false }, { "name": "filter[user_id]", "in": "query", "schema": { "type": "string" }, "description": "Filter PeopleAttributes by user_id", "required": false } ], "responses": { "200": { "description": "Fetch List", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "Data", "items": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "properties": { "attributes": { "type": "object", "description": "Attributes", "properties": { "slug": { "type": "string", "x-nullable": true, "description": "" }, "type": { "type": "string", "x-nullable": true, "description": "" }, "builtin": { "type": "boolean", "x-nullable": true, "description": "" }, "name": { "type": "string", "x-nullable": true, "description": "" }, "placeholder": { "type": "string", "x-nullable": true, "description": "" }, "description": { "type": "string", "x-nullable": true, "description": "" }, "user_id": { "type": "string", "x-nullable": true, "description": "" }, "options": { "type": "array", "x-nullable": false, "description": "", "items": { "type": "object", "properties": { "label": { "type": "string", "x-nullable": false, "description": "" }, "value": { "type": "string", "x-nullable": false, "description": "" }, "position": { "type": "integer", "x-nullable": false, "description": "" } } } } } } } } ] } }, "meta": { "$ref": "#/components/schemas/Meta" } }, "required": [ "data" ] }, "examples": { "application/vnd.api+json": { "value": { "data": [ { "id": "13af2944-4969-41c9-b1ab-cd28393c0856", "type": "people_attributes", "attributes": { "slug": "company", "type": "text", "builtin": true, "name": "Company", "placeholder": "Company", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "2a7bf154-8841-4f35-97f1-af74323d223a", "type": "people_attributes", "attributes": { "slug": "last_name", "type": "text", "builtin": true, "name": "Last Name", "placeholder": "Last Name", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "3383889e-ffff-479b-b604-9a2cdac9e87a", "type": "people_attributes", "attributes": { "slug": "address", "type": "text", "builtin": true, "name": "Address", "placeholder": "Address", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "394e6a70-64b4-4c3f-aa41-ef05b2395568", "type": "people_attributes", "attributes": { "slug": "country", "type": "text", "builtin": true, "name": "Country", "placeholder": "Country", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "6bea7ed5-cb9b-4966-8140-70d7d203ef14", "type": "people_attributes", "attributes": { "slug": "facebook", "type": "url", "builtin": true, "name": "Facebook", "placeholder": "Facebook", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "6ce6260a-3585-41c1-9ce0-1f3559e18c8e", "type": "people_attributes", "attributes": { "slug": "website", "type": "url", "builtin": true, "name": "Website", "placeholder": "Website", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "78b8cb58-c82b-4cc2-a2e3-332aec6770f0", "type": "people_attributes", "attributes": { "slug": "first_name", "type": "text", "builtin": true, "name": "First Name", "placeholder": "First Name", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "79be7276-c4e1-4d5c-934c-ef2f75a54eb3", "type": "people_attributes", "attributes": { "slug": "email", "type": "email", "builtin": true, "name": "Email", "placeholder": "Email", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "83c88379-cd5a-4db8-8c44-8ce9305959dd", "type": "people_attributes", "attributes": { "slug": "city", "type": "text", "builtin": true, "name": "City", "placeholder": "City", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "a86ace6c-692a-41a9-be95-60084a43d8a6", "type": "people_attributes", "attributes": { "slug": "slug-1", "type": "text", "builtin": false, "name": "Name 1", "placeholder": "Placeholder 1", "description": "Description 1", "user_id": "93b4f775-bf43-427a-b401-1d6e4f6dced8", "created_at": 1733758897, "updated_at": 1733758897 } }, { "id": "b6d3bd57-ecd9-42e0-a9b9-3b59f4af9d83", "type": "people_attributes", "attributes": { "slug": "avatar", "type": "avatar", "builtin": true, "name": "Avatar", "placeholder": "Avatar", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "e6498732-0ef3-4318-8ac4-66cc1cd202e8", "type": "people_attributes", "attributes": { "slug": "twitter", "type": "text", "builtin": true, "name": "Twitter username", "placeholder": "Twitter username", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "fd275488-a3a4-4255-9869-e6759396537b", "type": "people_attributes", "attributes": { "slug": "linkedin", "type": "url", "builtin": true, "name": "LinkedIn", "placeholder": "LinkedIn", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "ff307919-b83b-4844-9cf5-e7bb49d35634", "type": "people_attributes", "attributes": { "slug": "phone", "type": "text", "builtin": true, "name": "Phone Number", "placeholder": "Phone Number", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } }, { "id": "ffc8f2b0-1419-408a-be29-db14412dac5d", "type": "people_attributes", "attributes": { "slug": "job_title", "type": "text", "builtin": true, "name": "Job title", "placeholder": "Job title", "description": null, "user_id": null, "created_at": 1733129687, "updated_at": 1733129687 } } ], "meta": { "current_page": 0, "previous_page": null, "next_page": null, "record_count": 15, "page_count": 1, "items_per_page": 15 } } } } } }, "headers": { "RateLimit-Monthly-Remaining": { "schema": { "type": "integer" }, "description": "The number of requests remaining for the current month" }, "RateLimit-Monthly-Limit": { "schema": { "type": "integer" }, "description": "The number of allowed requests for the current month" }, "RateLimit-Interval-Remaining": { "schema": { "type": "integer" }, "description": "The number of requests remaining for the current rate limit window (1 second)" }, "RateLimit-Interval-Limit": { "schema": { "type": "integer" }, "description": "The number of allowed requests for the current period (1 second)" } } }, "401": { "description": "Authentication failed", "content": {} }, "403": { "description": "Workspace blocked", "content": {} }, "429": { "description": "Too Many Requests", "content": {}, "headers": { "RateLimit-Interval-Limit": { "schema": { "type": "integer" }, "description": "The number of allowed requests for the current period (1 second)" }, "RateLimit-Interval-Remaining": { "schema": { "type": "integer" }, "description": "The number of remaining requests for the current period (1 second)" }, "Retry-After": { "schema": { "type": "integer" }, "description": "The number of seconds you are required to wait before the next successful request" }, "RateLimit-Reset": { "schema": { "type": "integer" }, "description": "A timestamp of when the limit will be reset" } } } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```