Project find

Look up projects

Resolve a list of project names or slugs to their canonical Sumble projects. Pass a projects array (1–1000 entries) and receive one entry in results for every input, in the same order you supplied them.

Each result pairs your original input with the matched project, or null when nothing matches — so the response always lines up one-to-one with your request. Use a matched project's canonical slug as the identifier for other API endpoints.

The response also returns matched_count, the number of inputs that resolved to a project.

Use this endpoint when you already have a set of project names or slugs — for example, from a spreadsheet or a prior call — and need stable, canonical identifiers to pass into follow-up requests.

File download

Set file_name to a filename ending in .csv, .xlsx for an Excel workbook, or .json, to download the matches.

A .json file contains one object per input in the same structure as the inline results, so the matched project stays an object.

A .csv or .xlsx file contains one row per input, including unmatched inputs, with separate columns for the matched project's ID, slug, and name.

The response keeps matched_count and the credit fields, returns the file metadata, and leaves results empty. Opening the download URL requires the file owner's Sumble web session.

Credit cost

1 credit per 100 matched projects. Unmatched inputs do not consume credits.

Look up projects by name

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

projectsstring[] · min: 1 · max: 1000Required

List of project names or slugs to look up

Responses

200

Successful Response

application/json

idstring · uuidRequired

credits_usedintegerRequired

credits_remainingintegerRequired

matched_countintegerRequired

422

Validation Error

application/json

post/v9/projects/lookup

POST /v9/projects/lookup HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "projects": [
    "cloud migration",
    "generative_ai"
  ]
}

{
  "id": "019c2a87-11f0-78b3-b82d-cdd178cf4018",
  "credits_used": 1,
  "credits_remaining": 999,
  "matched_count": 2,
  "results": [
    {
      "input": "cloud migration",
      "project": {
        "id": 1,
        "slug": "cloud_migration",
        "name": "Cloud Migration"
      }
    },
    {
      "input": "generative_ai",
      "project": {
        "id": 3,
        "slug": "generative_ai",
        "name": "Generative AI"
      }
    }
  ]
}