/bitbucket/repositories/search

POST /api/bitbucket/repositories/search

Price: 10 credits

List repositories of a Bitbucket workspace with optional query filter and sort

How to use it

List the public repositories of a Bitbucket workspace by workspace slug. Optionally filter with a Bitbucket query expression (e.g. 'language="python"', 'name~"api"', 'updated_on>2024-01-01') and sort by updated, created, name, or size. Returns full repository objects: uuid, name, description, language, privacy, timestamps, owner, project, clone URL, and avatar.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• workspace string required — Workspace slug or UUID to search repositories within (examples: "atlassian", "bitbucketpipelines"; minLength: 1)
• count integer required — Number of repositories to return (min: 1)
• query string nullable — Bitbucket query filter over repository fields, e.g. 'language="python"', 'name~"api"', 'updated_on>2024-01-01', combinable with AND/OR (examples: "language=\"javascript\"", "name~\"connect\"")
• sort string — Sort repositories by this field (default: "-updated_on"; one of: "-updated_on", "updated_on", "-created_on", "created_on", "name", "-name", "-size", "size")

Response

• @type string (default: "BitbucketRepository")
• uuid string required
• alias string required
• name string required
• description string nullable
• scm string (default: "")
• language string nullable
• is_private boolean (default: false)
• fork_policy string (default: "")
• website_url string nullable
• default_branch string (default: "")
• size integer (default: 0)
• has_issues boolean (default: false)
• has_wiki boolean (default: false)
• created_at string (default: "")
• updated_at string (default: "")
• owner_alias string (default: "")
• owner_name string (default: "")
• owner_type string (default: "")
• owner_image string nullable
• workspace_alias string (default: "")
• workspace_name string (default: "")
• project_key string (default: "")
• project_name string (default: "")
• parent_alias string nullable
• clone_url string (default: "")
• image string nullable
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Workspace not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.