Hopp til innholdet
Sursa Developers

GET/v1/cards

Vis kort

list_cards

Returnerer kort med filtre, sortering og paginering. Med preview=1 (for flisvisningen) har hvert kort også preview (de første 200 tegnene av teksten) og preview_tables (ark med antall rader), innenfor dataprofilen din.

Autentisering

Send en API-nøkkel i headeren Authorization: Authorization: Bearer <nøkkel>.

Spørringsparametere

  • collectionstring | null
  • folderstring | null

    <folder ID> returnerer kortene i mappen og alle undermappene. none returnerer kortene i samlingen som ikke ligger i noen mappe, og krever collection (ellers 400 cards.invalid_folder_filter). Hvis mappen ikke finnes eller ikke er synlig for deg, returnerer forespørselen 404 folders.not_found.

    length ≤ 64

  • statusstring | null

    Tillatte verdier: processingreadyerrorarchivedall

  • ownerstring | null

    me, none eller en brukers ID.

  • owner_idinteger | null
  • verificationstring | null

    Tillatte verdier: verifiedneeds_verificationstale

  • kindCardKind
  • typestring | null

    table returnerer kort med faktatabeller, text returnerer kort uten.

    Tillatte verdier: tabletext

  • tagsstring | null

    Kommaseparerte tagger (et kort må ha alle).

  • idsstring | null

    Kommaseparerte kort-ID-er.

  • searchstring | null
  • categorystring | null
  • sensitiveboolean | null
  • sortCardSort

    Standard: "created_at"

  • orderstring

    Tillatte verdier: ascdesc

    Standard: "desc"

  • limitinteger

    Standard: 200

  • offsetinteger

    Standard: 0

  • previewboolean

    true legger til preview (de første 200 tegnene) og preview_tables for flisvisningen.

    Standard: false

  • updated_sincestring (date-time)

    Bare kort med updated_at på eller etter dette tidspunktet (RFC 3339 med tidssoneforskyvning), for synkronisering. Uten eksplisitt sort og order sorteres listen etter updated_at stigende, deretter etter id. Slettede kort vises ikke i listen: slettinger kommer som hendelser.

  • metadatamap of string

    Filter på metadata: metadata[<key>]=<value> gir eksakt treff. Opptil 3 betingelser, og alle må være oppfylt (?metadata[team]=support&metadata[crm_id]=A-1042). Flere enn 3 betingelser eller en ugyldig nøkkel returnerer 400 api.metadata_invalid.

  • collection_idinteger

    Samling etter ID. Når collection også sendes, har collection_id forrang. En samling som ikke finnes i organisasjonen eller ikke er synlig, returnerer 404 collections.not_found.

  • external_idstring

    Bare kortet med denne external_id.

  • cursorstring

    Cursor for neste side fra X-Next-Cursor eller next_cursor i forrige svar med de samme filtrene; den inneholder sidestørrelsen. Sammen med offset: 422 validation.failed; en cursor fra en annen liste, med andre filtre eller i feil format: 400 api.cursor_invalid.

    length ≤ 512

  • expand[]array of string

    Relaterte objekter som skal tas med i svaret (fra og med 1.62.0): en bane fra listen x-expandable for operasjonen. Gjenta parameteren opptil 10 ganger. En bane har opptil 2 ledd adskilt med punktum (collection.default_owner). I en liste begynner banen med data. og gjelder for hvert element på siden (expand[]=data.owner). Et utvidet objekt legges i objektet expanded for elementet, og ID-feltet blir stående. Et objekt som kalleren ikke har lov til å se etter kontrollene i objektets egen leseoperasjon, utvides som null. En ukjent bane, mer enn 10 baner eller en bane med mer enn 2 ledd returnerer 400 api.expand_invalid.

    items ≤ 10

Headerparametere

  • X-View-Asstring

    Bare for API-nøkler med rollen admin. Utfører forespørselen som dataprofilen <profile>[:viewer|verifier|editor], for eksempel employee:viewer. Installasjonsnøkkelen kan ikke bruke denne headeren (403).

Parametere i informasjonskapsler

  • kb_view_asstring

    Informasjonskapsel for modusen «View as» (vis som) i en økt. POST /auth/view-as setter den, og DELETE /auth/view-as fjerner den.

Svar

200Vellykket svar

Headere i svaret

  • Link

    Adressen til neste side, <…>; rel="next". Ingen header betyr at dette er siste side.

  • X-Next-Cursor

    Cursor for neste side til parameteren cursor. Ingen header betyr at dette er siste side.

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: CardList

array of Card
  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    Tillatte verdier: wholepartial

  • access_contactstring

    Hvem man kontakter for å få tilgang (bare når access=partial).

  • aclobject
    Felt
    • verifybooleanobligatorisk
    • writebooleanobligatorisk
  • categorystringobligatorisk
  • category_confidencenumber | nullobligatorisk
  • category_lockedbooleanobligatorisk
  • category_reviewbooleanobligatorisk
  • category_sourceCategorySource | nullobligatorisk
  • collectionstringobligatorisk
  • collection_idintegerobligatorisk
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    Redigeringsinnholdet i den sist publiserte versjonen. Feltet kan mangle; hent da redigeringsinnholdet fra et utkast (POST /v1/drafts med card_id).

  • editing_lockEditingLock | null

    Aktiv redigeringslås. Feltet kan mangle; da får redigeringsprogrammet vite hvem som har låsen, fra 409 cards.locked på POST /v1/cards/{card_id}/lock.

  • created_atstring (date-time)obligatorisk
  • days_since_verifiedintegerobligatorisk
  • errorstring | nullobligatorisk
  • eventsarray of CardEvent
  • feedback_negintegerobligatorisk
  • feedback_posintegerobligatorisk
  • foldersarray of CardFolderRef

    Bare i kortlisten: mappene som inneholder kortet (de brukeren kan se), med stiene fra samlingens rot. En tom liste betyr at kortet ikke ligger i noen mappe.

  • has_tablesboolean

    Bare i kortlisten.

  • hidden_partsboolean
  • idstringobligatorisk
  • jobJob | null
  • kindCardKindobligatorisk
  • org_idintegerobligatorisk
  • owner_activeboolean | null
  • owner_idinteger | nullobligatorisk
  • owner_namestring | nullobligatorisk
  • pagesinteger | nullobligatorisk
  • parserstring | nullobligatorisk

    Dokumenttolkeren som en nøytral kode: document (full struktur: sider, overskrifter, tabeller, skannede sider), pdf (PDF-ens tekstlag), docx, xlsx, csv, markdown, html, text. Listen kan utvides.

  • partsarray of CardPartobligatorisk
  • sensitivebooleanobligatorisk
  • sha256string | nullobligatorisk
  • sizeintegerobligatorisk
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanobligatorisk
  • source_pathstring | nullobligatorisk
  • source_urlstring | nullobligatorisk
  • statusstringobligatorisk

    Tillatte verdier: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringobligatorisk
  • titlestringobligatorisk
  • trustnumberobligatorisk
  • trust_if_verifiednumber
  • trust_partsTrustPartsobligatorisk
  • updated_atstring (date-time)obligatorisk
  • verificationVerificationobligatorisk
  • verified_atstring (date-time) | nullobligatorisk
  • verified_byinteger | nullobligatorisk
  • verified_by_namestring | null
  • verifier_idsarray of integerobligatorisk
  • verifiersarray of object
    Felt
    • activebooleanobligatorisk
    • idintegerobligatorisk
    • namestringobligatorisk
  • verify_interval_daysintegerobligatorisk
  • versionintegerobligatorisk
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    Manuelle innstillinger for tolkingen (forhåndsvisning).

  • doc_kindDocKind | null

    Dokumenttype. null hvis typen ikke er fastslått (for eksempel for kort som ble indeksert før dokumenttyper ble innført).

  • doc_kind_confidencenumber | null

    Konfidens for dokumenttypen, fra 0 til 1.

  • doc_kind_sourcestring | null

    Hva som fastslo typen: regler (rules), en bruker (manual) eller automatisk klassifisering. Listen kan utvides: behandle en ukjent verdi som automatisk klassifisering.

    Tillatte verdier: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    Feltene i en faktura, en kreditnota eller en kvittering (bare for disse typene, og bare i kortet, ikke i listen). null hvis du ikke har tilgang til hele dokumentet, fordi feltene hentes ut fra hele dokumentet.

  • warningsarray of ReviewWarning

    Advarsler fra tolkingen av dokumentet (ReviewWarning; bare i kortet, ikke i listen).

  • enrichmentCardEnrichmentStatus | null

    Status for berikelsen (bare i kortet, ikke i listen). Dokumenttypen, fakturafeltene og de økonomiske postene legges til i bakgrunnen etter indekseringen og kan beregnes på nytt senere; de vises i kortet når de er klare. null betyr at ingen status er tilgjengelig (kortet ble indeksert uten berikelse i bakgrunnen).

  • external_idstring | null

    Kortets ID i integratorens system. Den er unik i organisasjonen blant kort som ikke kommer fra kilder; null betyr at den ikke er angitt. /v1/cards-by-external-id/{external_id} leser og erstatter kortet etter den.

    length ≤ 512

  • metadataMetadata
400Forespørselen er ugyldig: en parameterverdi eller objektets tilstand tillater ikke handlingen (`detail` er en melding).

Headere i svaret

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

401Ingen påloggingsinformasjon ble sendt (verken øktinformasjonskapsel eller API-nøkkel), eller nøkkelen ble ikke funnet.

Headere i svaret

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

403Handlingen er ikke tillatt: rollen er utilstrekkelig, det finnes ingen tilgang til samlingen eller kortet, forespørselen kjører i modusen «View as», eller organisasjonen er suspendert eller slettet (`detail` er et objekt med `code: org_suspended | org_deleted`).

Headere i svaret

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

404Objektet finnes ikke eller er ikke tilgjengelig for deg. API-et bekrefter ikke at et objekt med begrenset tilgang finnes.

Headere i svaret

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

422Valideringsfeil: brødteksten eller parameterne samsvarer ikke med skjemaet (`detail` er en liste over valideringsfeil), eller en parameterverdi er utenfor tillatt område (`detail` er en melding).

Headere i svaret

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

429For mange forespørsler (`api.rate_limited`), organisasjonens kvote for minuttet, døgnet eller måneden er brukt opp (`api.quota_exceeded`; `error.details` inneholder `quota`, `limit` og `reset_at`), organisasjonens grense er nådd, eller svartjenesten er opptatt (`answers.engine_busy`). Vent så lenge som headeren `Retry-After` angir.

Headere i svaret

  • Retry-After

    Antall sekunder du skal vente før du prøver forespørselen på nytt.

  • RateLimit-Policy

    Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.

  • RateLimit

    Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).

  • X-RateLimit-Remaining

    Gjenværende forespørsler under den strengeste grensen.

  • X-RateLimit-Reset

    Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

Feilkoder

Kodene denne operasjonen kan returnere i error.code, i tillegg til de generelle kodene for alle forespørsler.

Hastighetsgrenser

Svarene har headerne RateLimit og RateLimit-Policy og de eldre X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og prøv på nytt.

← cards · API-referanse