Projekt-API

Ett projekt är en AI-intervjuare med egna frågor. De flesta andra endpoints behöver ett projekt-ID, så det här är oftast det första anropet du gör. Läs mer om autentisering, paginering och fel under API-översikt.

Lista projekt#

HTTP

GET /api/v1/projects

Returnerar alla projekt i nyckelns organisation, de nyaste först, publicerade eller inte. Den tar inga parametrar och returnerar alla projekt på en sida.

Exempel#

curl "https://diaform.io/api/v1/projects" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Svar#

JSON

{
  "data": [
    {
      "id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "name": "Onboarding interviews",
      "product_name": "Acme",
      "published": true,
      "language": "english",
      "respondent_access": "public",
      "url": "https://acme.diaform.io/c/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "created_at": "2026-04-02T09:14:31.402057+00:00",
      "published_at": "2026-04-02T09:41:05.471073+00:00"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Fält för projekt#

Fält	Typ	Beskrivning
`id`	string	Projekt-ID
`name`	string eller null	Projektets namn som det visas i dashboarden
`product_name`	string eller null	Produkt- eller tjänstnamn från projektets inställningar
`published`	boolean	Om projektet är live
`language`	string eller null	Intervjuspråk, till exempel `english`
`respondent_access`	string	`public` (alla som har länken) eller `invite_only`
`url`	string eller null	Den publika konversationslänken. Den använder din verifierade egna domän om du har en.
`created_at`	string	När projektet skapades
`published_at`	string eller null	När det senast publicerades

Hämta ett projekt#

HTTP

GET /api/v1/projects/{project_id}

Returnerar ett projekt med dess aktuella frågor och antal konversationer.

Exempel#

curl "https://diaform.io/api/v1/projects/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Svar#

JSON

{
  "id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "name": "Onboarding interviews",
  "product_name": "Acme",
  "published": true,
  "language": "english",
  "respondent_access": "public",
  "url": "https://acme.diaform.io/c/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "created_at": "2026-04-02T09:14:31.402057+00:00",
  "published_at": "2026-04-02T09:41:05.471073+00:00",
  "questions": [
    {
      "id": "V1StGXR8_Z5jdHi6B-myT",
      "text": "How did your first week with the product go?",
      "type": "open_text",
      "required": false,
      "options": []
    },
    {
      "id": "tTJUuhijB3m3nvA5horJ6",
      "text": "Which plan are you on?",
      "type": "single_choice",
      "required": true,
      "options": [
        { "id": "fvbfMZcZXZLzZWCa-jXXJ", "label": "Starter" },
        { "id": "nb-XqVVvSICqEQjZ12Mox", "label": "Pro" }
      ]
    }
  ],
  "conversation_counts": {
    "total": 212,
    "completed": 148
  }
}

Projektet har alla fält från listan, plus:

Fält	Typ	Beskrivning
`questions`	array	De publicerade frågorna, i ordning
`questions[].id`	string	Frågans ID. Konversationssammanfattningar hänvisar till det som `question_id`.
`questions[].text`	string	Frågan som den är skriven
`questions[].type`	string	`open_text`, `single_choice`, `multiple_choice`, `nps`, `star_rating` eller `file_upload`
`questions[].required`	boolean	Om frågan är obligatorisk
`questions[].options`	array	Alternativen i en valfråga, vart och ett med `id` och `label`. Tom för andra typer.
`conversation_counts.total`	number	Konversationer som åtminstone har öppnats
`conversation_counts.completed`	number	Konversationer som nådde slutet

Frågor kan ändras över tid. En konversations sammanfattning behåller den formulering som respondenten faktiskt fick.