GEgetauctor
spaces

List Spaces

Changed on
get/v2/spaces

Request

  • Base URL
    https://api.getauctor.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.getauctor.com/v2/spaces
  • Auth
    none declared

Query parameters

type'account' | 'project' | 'organization' nullable

Filter spaces by scope. Only account, project, and organization are filterable. Personal spaces are organization-exclusive and are never returned by this org-scoped listing, so personal is not a valid filter value and personal spaces are already excluded by default.

parent_idstring nullable
user_idstring nullable

Filter to spaces the given user is a member of

external_idstring nullable

Filter by external ID value

external_id_type'jira' | 'linear' | 'azure_devops' | 'hubspot' | 'salesforce' | 'snow_acct' | 'snow_opp' nullable

External ID provider type (required when external_id is provided)

custom_field_idstring nullable

Filter to account/project spaces whose template defines this custom field (the id returned by GET /v2/spaces/{space_id}/custom-fields). Combine with custom_field_value to match a specific value.

custom_field_valuestring nullable

Filter to spaces whose custom field equals this value. The stored value is compared as text, so numbers and booleans match their string form (42, true). Requires custom_field_id.

limitinteger
offsetinteger

Response

Successful Response

totalinteger required

Changes

  • a5de876e9fc3Revision changes
    • info

      added the new optional query request parameter custom_field_id

    • info

      added the new optional query request parameter custom_field_value

  • aeb6faa3b8f0Revision changes
    • info

      added the new optional query request parameter user_id

    • info

      removed the personal enum value from the // response property for the response status