Skip to main content
POST
/
api
/
find_references
Find symbol references
curl --request POST \
  --url https://api.example.com/api/find_references \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "symbolName": "<string>",
  "language": "<string>",
  "revisionName": "<string>",
  "repoName": "<string>"
}
'
{
  "stats": {
    "matchCount": 123
  },
  "files": [
    {
      "fileName": "<string>",
      "repository": "<string>",
      "repositoryId": 123,
      "webUrl": "<string>",
      "language": "<string>",
      "matches": [
        {
          "lineContent": "<string>",
          "range": {
            "start": {
              "byteOffset": 123,
              "lineNumber": 123,
              "column": 123
            },
            "end": {
              "byteOffset": 123,
              "lineNumber": 123,
              "column": 123
            }
          }
        }
      ]
    }
  ],
  "repositoryInfo": [
    {
      "id": 123,
      "codeHostType": "github",
      "name": "<string>",
      "displayName": "<string>",
      "webUrl": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Send either a Sourcebot API key (sbk_...) or, on EE instances with OAuth enabled, an OAuth access token (sboa_...) in the Authorization header.

Body

application/json
symbolName
string
required
language
string
revisionName
string
repoName
string

Response

Symbol reference locations.

stats
object
required
files
object[]
required
repositoryInfo
object[]
required