Hex Projects API is one of 11 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes
15 operations
across 11 paths,
and defines 69 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://app.hex.tech/api.
The identity and technical contract details declared by the specification.
NotificationRecipient
object
3 properties
2 required
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
ProjectApiResource
object
17 properties
16 required
InvalidParam
object
Information about an input parameter pass to the API call that could not be parsed.
4 properties
4 required
ProjectRunResponsePayload
object
Response format returned by the runProject endpoint
7 properties
6 required
RunProjectRequestBody
object
Request body format for triggering a project run
7 properties
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
error.FORBIDDEN
object
The error information
3 properties
2 required
StateEvent
object
Response format returned by the runProject endpoint
3 properties
3 required
ProjectStatusResponsePayload
object
Response format returned by the getRunStatus endpoint
13 properties
10 required
CollectionId
string
Unique ID for a collection.
ProjectId
string
Unique ID for a Hex project. This can be found in the Variables side bar of the Logic View of a project, or by visiting the Project, and copying the UUID after…
EditProjectSharingGroupsResponse
object
2 properties
1 required
NextPageUrl
string
URL to fetch the next page of results for a paginated API request
EnumValues_typeofRunTypeFilter_
string
NotificationRecipientType
string
The delivery type of a notification recipient.
ShareProjectWithWorkspaceError
object
2 properties
2 required
GroupId
string
Unique ID for a group. This can be found from the groups page (in Settings).
ScheduleCadenceApiEnum
Types of cadence of a schedule for a Hex project.
ProjectQueriedTableResource
object
3 properties
3 required
RunStatusUrl
string
URL to query the status of the project run via the Hex API
ShareProjectWithGroupError
object
2 properties
2 required
ShareProjectWithCollectionError
object
2 properties
2 required
DataConnectionId
string
Unique ID for a data connection.
Timestamp
string
An ISO 8601 timestamp with timezone like 1970-01-01T00:00:00Z.
NotFoundParam
string
Name of an input parameter passed to the API call that was not found in the project.
EnumValues_typeofScheduleCadenceApiEnum_
string
PageSize
integer
Number of results to fetch per page for paginated requests
ProjectRunNotification
object
The configuration details for notifications, which are sent after a run has completed.
8 properties
2 required
ProjectQueriedTablesApiResource
object
3 properties
3 required
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties
2 required
ResponseRunId
string
Unique ID for a run of a Hex project
ProjectRunNotificationRecipient
object
The recipient of a project run notification, which will include the type of recipient and additional configuration details. This is used to determine who to se…
7 properties
4 required
SharingResource
object
6 properties
6 required
EnumValues_typeofSortByEnum_
string
error.NOT_FOUND
object
The error information
3 properties
2 required
EditProjectSharingWorkspaceAndPublicResponse
object
2 properties
1 required
InvalidParamPayload
object
3 properties
3 required
EnumValues_typeofDayOfWeekApiEnum_
string
PaginationApiResource
object
2 properties
2 required
ProjectsListApiResource
object
2 properties
2 required
InputRunId
string
Unique ID for a run of a Hex project. This ID is part of the response returned by the RunProject endpoint. The GetProjectRuns endpoint can also be used to find…
TsoaErrorResponsePayload
object
3 properties
1 required
EditProjectSharingUsersResponse
object
2 properties
1 required
ProjectStatusRunTrigger
string
How a run of a project was triggered (API, SCHEDULED, or APPREFRESH)
ProjectRunsResponsePayload
object
4 properties
4 required
EditProjectSharingCollectionsResponse
object
2 properties
1 required
ProjectTypeApiEnum
The type of the ProjectApiResource being returned.
ShareProjectWithUserError
object
2 properties
2 required
ScreenshotFormatType
string
The file format of the generated screenshot.
EnumValues_typeofProjectTypeApiEnum_
string
ProjectVersion
integer
The version of the Hex project that was run. Project versions are ordered, starting at 1 and incrementing on each saved version. Project versions can be found…
AccessLevelEnum
Access level granted by sharing endpoints. For projects, CANVIEW is the API value that corresponds to the UI permission labeled "Can explore". APPONLY is the A…
EnumValues_typeofAccessLevelEnum_
string
RunNotificationType
string
The condition that determines whether or not the notification should be delivered based on these types.
Offset
integer
Offset for paginated requests
UserId
string
Unique ID for a user. This can be found from the users page (in Settings).
error.UNAUTHORIZED
object
The error information
3 properties
2 required
ScheduleApiResource
object
7 properties
7 required
RunUrl
string
URL to view the current progress of the project run in the Hex UI
error.BAD_REQUEST
object
The error information
3 properties
2 required
TimezoneDesignator
string
An ISO 8601 timezone designator like +08:00.
EnumValues_typeofSortDirectionEnum_
string
ProjectRunStatus
string
Current status of a project run
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Hex publishes across the network.
