v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

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.

get/api/v1/teams/{team}/custom_objects

Path parameters

teamstring required

Team ID (team_...). Scopes results to objects owned by this team.

Query parameters

row_keystring

Filter results to objects whose row_key exactly matches this value.

sort_keystring

Filter results to objects whose sort_key exactly matches this value.

querystring

Full-text search string matched against the schema's configured search_fields. When provided, results are ordered by relevance score descending instead of creation time descending.

limitinteger

Maximum number of objects to return per page.

offsetinteger

Number of objects to skip before returning results. Use with limit for page-based pagination.

typestring required

Schema type identifier (lookup_key) that filters results to objects of this schema.

Response

Successful response

metaobject

Pagination metadata for the response.

Example response

{
  "data": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "fields": {
        "key": "value"
      },
      "id": "cobj_0aBcDeFgHiJkLmNoPqRsTu",
      "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
      "row_key": "string",
      "sandbox": "dsb_0aBcDeFgHiJkLmNoPqRsTu",
      "schema_type": "contact",
      "team": "tem_0aBcDeFgHiJkLmNoPqRsTu",
      "updated_at": "2024-01-01T00:00:00Z",
      "user": "usr_0aBcDeFgHiJkLmNoPqRsTu",
      "version": 1
    }
  ],
  "meta": {}
}