ArchAstro.V1.Teams.CustomObjects (archastro v0.2.0)

Copy Markdown

TeamCustomObject API resource.

Summary

Functions

Create a team custom object

List a team's custom objects

Functions

create(client, team, input)

Create a team custom object

Creates a new custom object owned by the specified team. The object is instantiated against the schema identified by type (the schema's lookup_key). All field values are validated against that schema's field definitions before the object is persisted.

The authenticated user must be a member of the team with sufficient access. If the team is not found or the caller lacks access, the endpoint returns 404. If type does not match a registered schema for the team's organization, the endpoint also returns 404.

The newly created custom object.

list(client, team, params)

List a team's custom objects

Returns a paginated list of custom objects owned by the specified team, filtered to a single schema type. Results are ordered by creation time descending unless query is provided, in which case they are ordered by full-text relevance score descending.

Use limit and offset for page-based pagination. Use row_key or sort_key to narrow results to objects matching those index values. Full-text search via query operates only against the fields configured as search_fields on the schema.

The authenticated user must be a member of the team with sufficient access. Returns 404 if the team is not found, the caller lacks access, or type does not match a registered schema for the team's organization.

Successful response