Skip to content

Workspace ID lookup

GET /api/v1/workspaces

Returns the workspaces owned by the API key’s account. Use an ID from this response when starting a search. The endpoint does not create workspaces or return other users’ workspaces.

Terminal window
curl --fail-with-body \
'https://githoundexplore.com/api/v1/workspaces' \
-H "Authorization: Bearer $GITHOUND_API_KEY"
ParameterLocationRequiredDescription
cursorQueryNoOpaque next_cursor from the preceding response.

Do not send a limit, page, or other query parameter. The server returns up to 100 workspaces per page.

200 OK · application/json

Illustrative response:

{
"workspaces": [
{
"id": "123e4567-e89b-42d3-a456-426614174000",
"name": "Exposure review"
}
],
"next_cursor": null
}
FieldTypeMeaning
workspacesarrayZero to 100 owned workspaces.
workspaces[].idUUID stringIdentifier for the search endpoint.
workspaces[].namestringWorkspace display name, up to 200 characters.
next_cursorstring or nullPass unchanged to retrieve the next page; null means the final page.

An empty workspaces array is a successful response. Create a workspace in the GitHound application if you do not yet have one.

Terminal window
curl --fail-with-body --get \
'https://githoundexplore.com/api/v1/workspaces' \
-H "Authorization: Bearer $GITHOUND_API_KEY" \
--data-urlencode "cursor=$NEXT_CURSOR"

Treat cursors as opaque. They are account-bound and expire after 24 hours. If a cursor expires or becomes invalid, restart from the first page. Do not decode, modify, share across accounts, or persist cursors as permanent workspace identifiers.

The server orders pages by workspace creation time and identifier. Pagination is not a snapshot: concurrent workspace changes can affect what is available while you paginate.

400 invalid_cursor means the cursor is malformed, expired, or belongs to another account. Authentication and eligibility errors are described in Errors.

Workspace lists are limited to 60 requests per minute per account, shared by all keys. They do not consume a code-search daily allowance. A separate per-IP ingress limit also applies.