Documentation développeursAPI v1

Référence

projects · API

Endpoints, paramètres, corps de requête et schémas de réponse pour projects dans l’API v1 de Squario.

projects

10 opérations documentées

Les descriptions du contrat et les schémas restent en anglais, tels que générés par l’API.

GET/v1/projects

List projects

Opération list_projects

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
pageFacultatifquery

1-based page number, for pages within the first 10,000 records (the last is floor(10000 / page_size) + 1). Deeper, walk with cursor. Not combinable with cursor.

Afficher le schéma JSON
{
  "type": "integer",
  "minimum": 1,
  "maximum": 10000,
  "default": 1
}
cursorFacultatifquery

Keyset pagination: start begins a walk, then send each response's meta.next_cursor verbatim until it is null. Reaches any depth; keep the same sort, order, search and filters throughout. Not combinable with page.

Afficher le schéma JSON
{
  "type": "string"
}
page_sizeFacultatifquery

Records per page.

Afficher le schéma JSON
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 25
}
sortFacultatifquery

A sortable field key (GET /v1/resources/{resource} lists sort_keys). Default: newest first.

Afficher le schéma JSON
{
  "type": "string"
}
orderFacultatifquery

Sort direction.

Afficher le schéma JSON
{
  "type": "string",
  "enum": [
    "asc",
    "desc"
  ],
  "default": "desc"
}
searchFacultatifquery

Free-text search.

Afficher le schéma JSON
{
  "type": "string"
}
include_archivedFacultatifquery

Include archived records.

Afficher le schéma JSON
{
  "type": "boolean",
  "default": false
}
filterFacultatifquery

A URL-encoded JSON array of filters.

application/json · Afficher le schéma JSON
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Filter"
  }
}
joinFacultatifquery

How filters combine.

Afficher le schéma JSON
{
  "type": "string",
  "enum": [
    "and",
    "or"
  ],
  "default": "and"
}
fieldsFacultatifquery

Comma-separated top-level properties to return (id is always kept); a name the record does not have is skipped. Omit for every property.

Afficher le schéma JSON
{
  "type": "string"
}

Réponses

200 One page of records.

application/json

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/projects_record"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/ListMeta"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
422 The workspace refused the values (unknown field, required field, rule), or the Idempotency-Key was already used for a different request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
POST/v1/projects

Create one of projects

Opération create_projects

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
Idempotency-KeyFacultatifheader

Makes the write safe to retry: a repeat of the same request with the same key within 24 hours returns the first successful response (with Idempotent-Replayed: true) instead of writing again. The same key on a different request is refused (422 idempotency_key_reused); while the first is still running, 409 idempotency_key_in_use. A failed request releases its key. Up to 255 printable ASCII characters; use a UUID.

Afficher le schéma JSON
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de requête

Obligatoire

application/json · Afficher le schéma JSON
{
  "type": "object",
  "additionalProperties": true,
  "description": "Field values keyed by field key; only the fields to set. Custom fields as cf__<key> fields or as one `custom_fields` object (not both). An unknown field is refused (422). data_model_records take `model_id` here or as a query parameter. GET /v1/resources/{resource} lists the writable fields."
}

Réponses

201 The created record.

application/json

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/projects_record"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
  • Location The created record's URL.
  • Idempotent-Replayed true when this is the stored response to an earlier request with the same Idempotency-Key.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
405 The method is not allowed here (e.g. a write on a read-only resource).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Allow
409 The write conflicts with an existing record, or a request with the same Idempotency-Key is still running.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
413 The body is over 1 MiB.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
422 The workspace refused the values (unknown field, required field, rule), or the Idempotency-Key was already used for a different request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
POST/v1/projects/query

List projects, parameters in the body

Opération query_projects

The list endpoint with its parameters as JSON (filters as a real array). Counts as a read.

Authentification · Clé API de l’espace de travail

Paramètres

Cette opération n’a aucun paramètre.

Corps de requête

Facultatif

application/json · Afficher le schéma JSON
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "default": 1,
      "description": "1-based page number, for pages within the first 10,000 records (the last is floor(10000 / page_size) + 1). Deeper, walk with `cursor`. Not combinable with `cursor`."
    },
    "cursor": {
      "type": "string",
      "description": "Keyset pagination: `start` begins a walk, then send each response's `meta.next_cursor` verbatim until it is null. Reaches any depth; keep the same sort, order, search and filters throughout. Not combinable with `page`."
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 25
    },
    "sort": {
      "type": "string"
    },
    "order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "search": {
      "type": "string",
      "description": "Free text; full-text-indexed resources only."
    },
    "include_archived": {
      "type": "boolean",
      "default": false
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Filter"
      }
    },
    "join": {
      "type": "string",
      "enum": [
        "and",
        "or"
      ],
      "default": "and"
    },
    "model_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required for data_model_records only."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "description": "Top-level properties to return (`id` is always kept); a name the record does not have is skipped."
    }
  }
}

Réponses

200 One page of records.

application/json

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/projects_record"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/ListMeta"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
413 The body is over 1 MiB.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
422 The workspace refused the values (unknown field, required field, rule), or the Idempotency-Key was already used for a different request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
GET/v1/projects/{id}

Get one of projects

Opération get_projects

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
idObligatoirepath

The record's UUID.

Afficher le schéma JSON
{
  "type": "string",
  "format": "uuid"
}
fieldsFacultatifquery

Comma-separated top-level properties to return (id is always kept); a name the record does not have is skipped. Omit for every property.

Afficher le schéma JSON
{
  "type": "string"
}

Réponses

200 The record.

application/json

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/projects_record"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
  • Idempotent-Replayed true when this is the stored response to an earlier request with the same Idempotency-Key.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
PATCH/v1/projects/{id}

Update one of projects

Opération update_projects

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
idObligatoirepath

The record's UUID.

Afficher le schéma JSON
{
  "type": "string",
  "format": "uuid"
}
Idempotency-KeyFacultatifheader

Makes the write safe to retry: a repeat of the same request with the same key within 24 hours returns the first successful response (with Idempotent-Replayed: true) instead of writing again. The same key on a different request is refused (422 idempotency_key_reused); while the first is still running, 409 idempotency_key_in_use. A failed request releases its key. Up to 255 printable ASCII characters; use a UUID.

Afficher le schéma JSON
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de requête

Obligatoire

application/json · Afficher le schéma JSON
{
  "type": "object",
  "additionalProperties": true,
  "description": "Field values keyed by field key; only the fields to set. Custom fields as cf__<key> fields or as one `custom_fields` object (not both). An unknown field is refused (422). data_model_records take `model_id` here or as a query parameter. GET /v1/resources/{resource} lists the writable fields."
}

Réponses

200 The record.

application/json

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/projects_record"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
  • Idempotent-Replayed true when this is the stored response to an earlier request with the same Idempotency-Key.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
405 The method is not allowed here (e.g. a write on a read-only resource).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Allow
409 The write conflicts with an existing record, or a request with the same Idempotency-Key is still running.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
413 The body is over 1 MiB.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
422 The workspace refused the values (unknown field, required field, rule), or the Idempotency-Key was already used for a different request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
DELETE/v1/projects/{id}

Archive one of projects

Opération archive_projects

A soft delete: the record is archived and can be restored.

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
idObligatoirepath

The record's UUID.

Afficher le schéma JSON
{
  "type": "string",
  "format": "uuid"
}
Idempotency-KeyFacultatifheader

Makes the write safe to retry: a repeat of the same request with the same key within 24 hours returns the first successful response (with Idempotent-Replayed: true) instead of writing again. The same key on a different request is refused (422 idempotency_key_reused); while the first is still running, 409 idempotency_key_in_use. A failed request releases its key. Up to 255 printable ASCII characters; use a UUID.

Afficher le schéma JSON
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de requête

Facultatif

application/json · Afficher le schéma JSON
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 1000
    }
  }
}

Réponses

200 The record.

application/json

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/projects_record"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
  • Idempotent-Replayed true when this is the stored response to an earlier request with the same Idempotency-Key.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
405 The method is not allowed here (e.g. a write on a read-only resource).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Allow
409 The write conflicts with an existing record, or a request with the same Idempotency-Key is still running.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
413 The body is over 1 MiB.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
422 The workspace refused the values (unknown field, required field, rule), or the Idempotency-Key was already used for a different request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
POST/v1/projects/{id}/restore

Restore an archived one of projects

Opération restore_projects

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
idObligatoirepath

The record's UUID.

Afficher le schéma JSON
{
  "type": "string",
  "format": "uuid"
}
Idempotency-KeyFacultatifheader

Makes the write safe to retry: a repeat of the same request with the same key within 24 hours returns the first successful response (with Idempotent-Replayed: true) instead of writing again. The same key on a different request is refused (422 idempotency_key_reused); while the first is still running, 409 idempotency_key_in_use. A failed request releases its key. Up to 255 printable ASCII characters; use a UUID.

Afficher le schéma JSON
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Réponses

200 The record.

application/json

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/projects_record"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
  • Idempotent-Replayed true when this is the stored response to an earlier request with the same Idempotency-Key.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
405 The method is not allowed here (e.g. a write on a read-only resource).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Allow
409 The write conflicts with an existing record, or a request with the same Idempotency-Key is still running.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
413 The body is over 1 MiB.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
422 The workspace refused the values (unknown field, required field, rule), or the Idempotency-Key was already used for a different request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
GET/v1/projects/{id}/deals

List the deals linked to one of projects

Opération list_projects_deals

A deal attached to a delivery project. The project's primary deal (its deal_id) is always linked and cannot be unlinked (409); point the project at another deal first. A key with a resource list must cover deals as well as projects.

Authentification · Clé API de l’espace de travail

Paramètres

Paramètres
ParamètreEmplacementContrat
idObligatoirepath

The record's UUID.

Afficher le schéma JSON
{
  "type": "string",
  "format": "uuid"
}
pageFacultatifquery

1-based page of links.

Afficher le schéma JSON
{
  "type": "integer",
  "minimum": 1,
  "maximum": 10000,
  "default": 1
}
page_sizeFacultatifquery

Links per page.

Afficher le schéma JSON
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 100
}

Réponses

200 One page of links, oldest first.

application/json

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/project_deals_link"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/LinkListMeta"
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • X-RateLimit-Limit Requests allowed in the window of the tightest rate limit (absent when none applies).
  • X-RateLimit-Remaining Requests left in that window.
  • X-RateLimit-Reset Seconds until that window resets.
  • X-Quota-Limit The workspace's monthly request quota (absent when uncapped).
  • X-Quota-Remaining Requests left this month (absent when uncapped).
  • X-Quota-Reset When the monthly quota resets.
400 Malformed parameters or body (invalid_request).

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
401 Missing, unknown, revoked or expired API key.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • WWW-Authenticate
403 The key or its owner may not make this request.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
404 No such route, resource or record.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
429 Rate limited, or the monthly quota is used up.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
  • Retry-After Seconds to wait before retrying.
  • X-RateLimit-Reset Seconds until that window resets.
500 Unexpected failure.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.
503 Temporarily unable to check the key or reach the data.

application/json

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

En-têtes de réponse

  • X-Request-Id This request's id; quote it when reporting a problem.

Définitions des schémas

Filter
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "field",
    "op"
  ],
  "properties": {
    "field": {
      "type": "string",
      "description": "A field key; a custom field's `filter_key` (cfv:<id>) from GET /v1/resources/{resource}; or rel:<fk_column>.<column> for a related record's column."
    },
    "op": {
      "type": "string",
      "enum": [
        "eq",
        "ne",
        "gt",
        "gte",
        "lt",
        "lte",
        "iLike",
        "notILike",
        "inArray",
        "notInArray",
        "isBetween",
        "isEmpty",
        "isNotEmpty"
      ]
    },
    "value": {
      "description": "A scalar for most operators; an array for inArray/notInArray; a [low, high] pair for isBetween; omitted for isEmpty/isNotEmpty. Dates are ISO 8601."
    }
  }
}
projects_record
{
  "type": "object",
  "title": "Project",
  "description": "A Project record as the key's owner may read it. Built-in fields are listed; custom fields and anything else the workspace adds arrive as further properties. GET /v1/resources/projects describes this workspace's fields.",
  "additionalProperties": true,
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "title": "Name",
      "x-squario-kind": "text"
    },
    "code": {
      "title": "Code",
      "x-squario-kind": "text"
    },
    "status_id": {
      "title": "Status",
      "x-squario-kind": "relation"
    },
    "health": {
      "title": "Health",
      "x-squario-kind": "enum"
    },
    "visibility": {
      "title": "Visibility",
      "x-squario-kind": "enum"
    },
    "owner_member_id": {
      "title": "Owner",
      "x-squario-kind": "relation"
    },
    "client_company_id": {
      "title": "Client company",
      "x-squario-kind": "relation"
    },
    "client_contact_id": {
      "title": "Client contact",
      "x-squario-kind": "relation"
    },
    "start_date": {
      "title": "Start date",
      "x-squario-kind": "date",
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "end_date": {
      "title": "End date",
      "x-squario-kind": "date",
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "budget_amount": {
      "title": "Budget",
      "x-squario-kind": "number",
      "type": [
        "number",
        "null"
      ]
    },
    "budget_currency_code": {
      "title": "Budget currency",
      "x-squario-kind": "relation"
    },
    "description": {
      "title": "Description",
      "x-squario-kind": "text"
    },
    "created_at": {
      "title": "Created",
      "x-squario-kind": "date",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
ListMeta
{
  "type": "object",
  "description": "Page mode carries `page`; cursor mode carries `next_cursor` and `cursor_supported` instead, and `has_more` is `next_cursor !== null`.",
  "required": [
    "page_size",
    "total",
    "has_more"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "description": "Page mode only."
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor mode only: send it as `cursor` for the next page; null on the last one."
    },
    "cursor_supported": {
      "type": "boolean",
      "description": "Cursor mode only. False when this sort cannot be walked (search relevance): the response is then a plain first page with no `next_cursor`."
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "total": {
      "type": "integer",
      "minimum": 0
    },
    "total_is_capped": {
      "type": "boolean",
      "description": "Present when the count stopped at its cap: `total` is then a lower bound."
    },
    "has_more": {
      "type": "boolean"
    }
  }
}
Error
{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "type",
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invalid_request_error",
            "authentication_error",
            "permission_error",
            "not_found_error",
            "conflict_error",
            "validation_error",
            "rate_limit_error",
            "api_error"
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "invalid_request",
            "invalid_api_key",
            "expired_api_key",
            "key_assurance_stale",
            "ip_not_allowed",
            "permission_denied",
            "plan_upgrade_required",
            "insufficient_scope",
            "feature_unavailable",
            "forbidden",
            "not_found",
            "unknown_resource",
            "route_not_found",
            "method_not_allowed",
            "conflict",
            "idempotency_key_in_use",
            "payload_too_large",
            "validation_failed",
            "idempotency_key_reused",
            "rate_limited",
            "quota_exceeded",
            "internal_error",
            "service_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        },
        "request_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}
RecordWrite
{
  "type": "object",
  "additionalProperties": true,
  "description": "Field values keyed by field key; only the fields to set. Custom fields as cf__<key> fields or as one `custom_fields` object (not both). An unknown field is refused (422). data_model_records take `model_id` here or as a query parameter. GET /v1/resources/{resource} lists the writable fields."
}
QueryRequest
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "default": 1,
      "description": "1-based page number, for pages within the first 10,000 records (the last is floor(10000 / page_size) + 1). Deeper, walk with `cursor`. Not combinable with `cursor`."
    },
    "cursor": {
      "type": "string",
      "description": "Keyset pagination: `start` begins a walk, then send each response's `meta.next_cursor` verbatim until it is null. Reaches any depth; keep the same sort, order, search and filters throughout. Not combinable with `page`."
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 25
    },
    "sort": {
      "type": "string"
    },
    "order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "search": {
      "type": "string",
      "description": "Free text; full-text-indexed resources only."
    },
    "include_archived": {
      "type": "boolean",
      "default": false
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Filter"
      }
    },
    "join": {
      "type": "string",
      "enum": [
        "and",
        "or"
      ],
      "default": "and"
    },
    "model_id": {
      "type": "string",
      "format": "uuid",
      "description": "Required for data_model_records only."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "description": "Top-level properties to return (`id` is always kept); a name the record does not have is skipped."
    }
  }
}
ArchiveRequest
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 1000
    }
  }
}
LinkListMeta
{
  "type": "object",
  "required": [
    "page",
    "page_size",
    "has_more"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "has_more": {
      "type": "boolean"
    }
  }
}

Sur ce site, nous comptons aussi les pages demandées sans vous identifier. Refusez la mesure d’audience pour arrêter les prochains comptages. Nous respectons Do Not Track et Global Privacy Control.

Politique de cookiesPolitique de confidentialité