Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/GET /v1/jobs/{jobId}/procurement

    GET /v1/jobs/{jobId}/procurement

    Read a job's procurement items

    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.

    Lists up to 500 vendor-ready rows derived from the job's recorded insights, highest score first. Each row has the compound id, vendor SKU and preferred supplier when the insight recorded them, a label, the insight's source and its score. Send Accept: application/json (or ?json=true) to get JSON; any other request gets the same data as a formatted HTML page. The response is not cached and carries an X-Items-Count header.

    You need access to the job (its owner, a project member or an administrator). With a project-scoped API key, a job outside the key's projects returns 404. Only GET is served.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Query parameters

    jsonstring

    Set to true to get JSON without sending an Accept header.

    Responses

    200 OK

    The job's procurement items

    Response shape:

    itemsobject[]

    Up to 500 rows, highest score first

    400 Bad Request

    The job id is empty

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    403 Forbidden

    You cannot access the job

    Response shape: object

    404 Not Found

    The job is outside your API key's project scope

    Response shape: object

    405

    The method is not GET; the Allow header says GET

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    Reading procurement items failed

    Response shape: object

    curl -X GET 'https://ivybiosciences.com/api/v1/jobs/{jobId}/procurement' \
      -H "Authorization: Bearer $IVY_API_KEY"

    Was this page helpful?

    Loading...