Skip to navigation

HTTP Specification

Conventions shared by every ACC Admin operation — pagination, filtering, errors and rate limits.

View as Markdown

All operations speak JSON over HTTPS (Content-Type: application/json) and are served from https://developer.api.autodesk.com under the version base path, for example /construction/admin/v1.

Common headers

HeaderDirectionPurpose
AuthorizationRequestBearer <token>. See Authentication.
User-IdRequestACC or Autodesk user ID to impersonate with a 2-legged token.
RegionRequestRoute the request explicitly (US, EMEA, …) instead of relying on automatic routing.
Request-IdBothCorrelation ID; echoed back on responses and worth logging for support requests.
RateLimit-ValueResponseRequests allowed in the current one-minute window.
RateLimit-RemainingResponseRequests left in the current window.

Pagination

List operations page with limit and offset.

  • limit defaults to 20, minimum 1, and is capped at 200 — a larger value still returns 200 records.
  • offset defaults to 0. limit=20&offset=40 returns records 41–60.
  • Responses carry a pagination object with the limit, offset and totalResults that produced them.

Filtering and sorting

Filters are query parameters of the form filter[field]=value, and text filters share a matching mode:

GET /construction/admin/v1/projects/:projectId/users?filter[name]=Sam&filterTextMatch=startsWith&sort=name%20asc&fields=name,email,status&limit=50
ParameterBehavior
filter[...]Restrict results. Multiple filters are ANDed.
orFiltersNames the filters that should be ORed with each other instead.
filterTextMatchcontains (default), startsWith, endsWith or equals.
sortComma-separated fields, each optionally asc/desc.
fieldsComma-separated response fields, to trim the payload.

Errors

Errors return a JSON body with a machine-readable code, a human-readable title/detail, and the Request-Id of the failed call.

StatusMeaning
400Malformed request — bad syntax, unknown field, or invalid filter value.
401Missing, expired or malformed token.
403Token is valid but lacks the scope, or the flow is not accepted (see Authentication).
404Hub, project or user does not exist, or is not visible to the caller.
409Conflicting state — for example adding a member who is already in the project.
429Rate limit exceeded. Back off using the RateLimit-* headers.
5xxTransient server error; retry with backoff.

Forward compatibility

Autodesk adds response attributes without a version bump. Parse responses leniently: ignore attributes your integration does not recognize instead of failing on them. Operations that are not backward compatible with BIM 360 projects say so on their reference page.